Murl::Logic::BaseTimeframe Class Reference

A helper class for simple use of the ITimeframe object. More...

#include "murl_logic_base_timeframe.h"

Inheritance diagram for Murl::Logic::BaseTimeframe:

Public Member Functions

 BaseTimeframe ()
 The default constructor. More...
 
virtual ~BaseTimeframe ()
 The destructor. More...
 
 operator IStepablePtr ()
 Conversion operator. More...
 
 operator ITimeframePtr ()
 Conversion operator. More...
 
- Public Member Functions inherited from Murl::Logic::Timeframe
virtual ~Timeframe ()
 The destructor.
 
virtual void ProcessTick (const Logic::IState *state)
 Implementation of IStepable::ProcessTick() method.
 
virtual IStepablePtr GetStepable ()
 Implementation of Timeframe::GetStepable() method.
 
virtual void Reset ()
 Implementation of Timeframe::Reset() method.
 
virtual void Start ()
 Implementation of Timeframe::Start() method.
 
virtual void Start (Real endTime)
 Implementation of Timeframe::Start(Real endTime) method.
 
virtual Bool SetCurrentTime (Real time)
 Implementation of Timeframe::SetCurrentTime() method.
 
virtual Bool Finish ()
 Implementation of Timeframe::Finish() method.
 
virtual Bool IsRunning () const
 Implementation of Timeframe::IsRunning() method.
 
virtual Bool WasStarted () const
 Implementation of Timeframe::WasStarted() method.
 
virtual Bool WasRunning () const
 Implementation of Timeframe::WasRunning() method.
 
virtual Bool IsOrWasRunning () const
 Implementation of Timeframe::IsOrWasRunning() method.
 
virtual Bool HasPassedTime (Real time) const
 Implementation of Timeframe::HasPassedTime() method.
 
virtual Bool SetTimeScale (Real timeScale)
 Implementation of Timeframe::SetTimeScale() method.
 
virtual Real GetTimeScale () const
 Implementation of Timeframe::GetTimeScale() method.
 
virtual Bool SetEndTime (Real endTime)
 Implementation of Timeframe::SetEndTime() method.
 
virtual Real GetEndTime () const
 Implementation of Timeframe::GetEndTime() method.
 
virtual Double GetCurrentTime () const
 Implementation of Timeframe::GetCurrentTime() method.
 
virtual Double GetRemainingTime () const
 Implementation of Timeframe::GetRemainingTime() method.
 
- Public Member Functions inherited from Murl::Logic::Stepable
virtual ~Stepable ()
 The destructor.
 
virtual Bool SetAppStepable (IAppStepablePtr appStepable)
 Implementation of IStepable::SetAppStepable() method.
 
virtual void SetEnabled (Bool isEnabled)
 Implementation of IStepable::SetEnabled() method.
 
virtual Bool IsEnabled () const
 Implementation of IStepable::IsEnabled() method.
 
virtual void FinishTick (const Logic::IState *state)
 Implementation of IStepable::FinishTick() method.
 

Additional Inherited Members

- Static Public Member Functions inherited from Murl::Logic::Timeframe
static ITimeframePtr Create ()
 Create a timeframe object. More...
 
- Static Public Member Functions inherited from Murl::Logic::Stepable
static IStepablePtr Create ()
 Create a stepable object. More...
 

Detailed Description

A helper class for simple use of the ITimeframe object.

A timeframe is created at object instantiation.

Constructor & Destructor Documentation

◆ BaseTimeframe()

Murl::Logic::BaseTimeframe::BaseTimeframe ( )
inline

The default constructor.

Creates a ITimeframe object.

◆ ~BaseTimeframe()

virtual Murl::Logic::BaseTimeframe::~BaseTimeframe ( )
inlinevirtual

The destructor.

Destroys the ITimeframe object.

Member Function Documentation

◆ operator IStepablePtr()

Murl::Logic::BaseTimeframe::operator IStepablePtr ( )
inline

Conversion operator.

Returns
The IStepable interface.

References Murl::Logic::Timeframe::GetStepable().

◆ operator ITimeframePtr()

Murl::Logic::BaseTimeframe::operator ITimeframePtr ( )
inline

Conversion operator.

Returns
The ITimeframe interface.

The documentation for this class was generated from the following file:
  • murl_logic_base_timeframe.h


Copyright © 2011-2018 Spraylight GmbH.