AIS_BaseAnimationObject Class Reference

Animation defining object transformation. More...

#include <AIS_BaseAnimationObject.hxx>

Inheritance diagram for AIS_BaseAnimationObject:

Protected Member Functions
	AIS_BaseAnimationObject (const TCollection_AsciiString &theAnimationName, const Handle< AIS_InteractiveContext > &theContext, const Handle< AIS_InteractiveObject > &theObject)
	Constructor with initialization.
void	updateTrsf (const gp_Trsf &theTrsf)
	Update the transformation.
Protected Member Functions inherited from AIS_Animation
virtual void	updateWithChildren (const AIS_AnimationProgress &thePosition)
	Process one step of the animation according to the input time progress, including all children. Calls also update() to update own animation.
virtual void	update (const AIS_AnimationProgress &theProgress)
	Update the own animation to specified position - should be overridden by sub-class.

Protected Attributes
Handle< AIS_InteractiveContext >	myContext
	context where object is displayed
Handle< AIS_InteractiveObject >	myObject
	presentation object to set location
Protected Attributes inherited from AIS_Animation
Handle< Media_Timer >	myTimer
TCollection_AsciiString	myName
	animation name
NCollection_Sequence< Handle< AIS_Animation > >	myAnimations
	sequence of child animations
AnimationState	myState
	animation state - started, stopped of paused
Standard_Real	myPtsStart
	time of start in the timeline
Standard_Real	myOwnDuration
	duration of animation excluding children
Standard_Real	myChildrenDuration
	duration of animation including children

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Public Member Functions inherited from AIS_Animation
	AIS_Animation (const TCollection_AsciiString &theAnimationName)
	Creates empty animation.
virtual	~AIS_Animation ()
	Destruct object, clear arguments.
const TCollection_AsciiString &	Name () const
	Animation name.
Standard_Real	StartPts () const
void	SetStartPts (const Standard_Real thePtsStart)
	Sets time limits for animation in the animation timeline.
Standard_Real	Duration () const
void	UpdateTotalDuration ()
	Update total duration considering all animations on timeline.
Standard_Boolean	HasOwnDuration () const
	Return true if duration is defined.
Standard_Real	OwnDuration () const
void	SetOwnDuration (const Standard_Real theDuration)
	Defines duration of the animation.
void	Add (const Handle< AIS_Animation > &theAnimation)
	Add single animation to the timeline.
void	Clear ()
	Clear animation timeline - remove all animations from it.
Handle< AIS_Animation >	Find (const TCollection_AsciiString &theAnimationName) const
	Return the child animation with the given name.
Standard_Boolean	Remove (const Handle< AIS_Animation > &theAnimation)
	Remove the child animation.
Standard_Boolean	Replace (const Handle< AIS_Animation > &theAnimationOld, const Handle< AIS_Animation > &theAnimationNew)
	Replace the child animation.
void	CopyFrom (const Handle< AIS_Animation > &theOther)
	Clears own children and then copy child animations from another object. Copy also Start Time and Duration values.
const NCollection_Sequence< Handle< AIS_Animation > > &	Children () const
	Return sequence of child animations.
virtual void	StartTimer (const Standard_Real theStartPts, const Standard_Real thePlaySpeed, const Standard_Boolean theToUpdate, const Standard_Boolean theToStopTimer=Standard_False)
	Start animation with internally defined timer instance. Calls Start() internally.
virtual Standard_Real	UpdateTimer ()
	Update single frame of animation, update timer state.
Standard_Real	ElapsedTime () const
	Return elapsed time.
const Handle< Media_Timer > &	Timer () const
	Return playback timer.
void	SetTimer (const Handle< Media_Timer > &theTimer)
	Set playback timer.
virtual void	Start (const Standard_Boolean theToUpdate)
	Start animation. This method changes status of the animation to Started. This status defines whether animation is to be performed in the timeline or not.
virtual void	Pause ()
	Pause the process timeline.
virtual void	Stop ()
	Stop animation. This method changed status of the animation to Stopped. This status shows that animation will not be performed in the timeline or it is finished.
bool	IsStopped ()
	Check if animation is to be performed in the animation timeline.
virtual Standard_Boolean	Update (const Standard_Real thePts)
	Update single frame of animation, update timer state.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Types inherited from AIS_Animation
enum	AnimationState { AnimationState_Started , AnimationState_Stopped , AnimationState_Paused }
	Defines animation state. More...

Detailed Description

Animation defining object transformation.

Constructor & Destructor Documentation

AIS_BaseAnimationObject()

AIS_BaseAnimationObject::AIS_BaseAnimationObject ( const TCollection_AsciiString &  theAnimationName, const Handle< AIS_InteractiveContext > &  theContext, const Handle< AIS_InteractiveObject > &  theObject  )

protected

Constructor with initialization.

Parameters

[in]	theAnimationName	animation identifier
[in]	theContext	interactive context where object have been displayed
[in]	theObject	object to apply local transformation

Member Function Documentation

updateTrsf()

void AIS_BaseAnimationObject::updateTrsf ( const gp_Trsf &  theTrsf )

protected

Update the transformation.

Field Documentation

myContext

Handle< AIS_InteractiveContext > AIS_BaseAnimationObject::myContext

protected

context where object is displayed

myObject

Handle< AIS_InteractiveObject > AIS_BaseAnimationObject::myObject

protected

presentation object to set location

---

The documentation for this class was generated from the following file:

• AIS_BaseAnimationObject.hxx