Open CASCADE Technology  7.3.0
Public Member Functions | Protected Member Functions | Protected Attributes

AIS_AnimationCamera Class Reference

Camera animation. More...

#include <AIS_AnimationCamera.hxx>

Inheritance diagram for AIS_AnimationCamera:
Inheritance graph
[legend]

Public Member Functions

 AIS_AnimationCamera (const TCollection_AsciiString &theAnimationName, const Handle< V3d_View > &theView)
 Main constructor. More...
 
const Handle< V3d_View > & View () const
 Return the target view. More...
 
const Handle< Graphic3d_Camera > & CameraStart () const
 Return camera start position. More...
 
void SetCameraStart (const Handle< Graphic3d_Camera > &theCameraStart)
 Define camera start position. More...
 
const Handle< Graphic3d_Camera > & CameraEnd () const
 Return camera end position. More...
 
void SetCameraEnd (const Handle< Graphic3d_Camera > &theCameraEnd)
 Define camera end position. More...
 
- Public Member Functions inherited from AIS_Animation
 AIS_Animation (const TCollection_AsciiString &theAnimationName)
 Creates empty animation. More...
 
virtual ~AIS_Animation ()
 Destruct object, clear arguments. More...
 
const TCollection_AsciiStringName () const
 Animation name. More...
 
Standard_Real StartPts () const
 
void SetStartPts (const Standard_Real thePtsStart)
 Sets time limits for animation in the animation timeline. More...
 
Standard_Real Duration () const
 
void UpdateTotalDuration ()
 Update total duration considering all animations on timeline. More...
 
Standard_Boolean HasOwnDuration () const
 Return true if duration is defined. More...
 
Standard_Real OwnDuration () const
 
void SetOwnDuration (const Standard_Real theDuration)
 Defines duration of the animation. More...
 
void Add (const Handle< AIS_Animation > &theAnimation)
 Add single animation to the timeline. More...
 
void Clear ()
 Clear animation timeline - remove all animations from it. More...
 
Handle< AIS_AnimationFind (const TCollection_AsciiString &theAnimationName) const
 Return the child animation with the given name. More...
 
Standard_Boolean Remove (const Handle< AIS_Animation > &theAnimation)
 Remove the child animation. More...
 
Standard_Boolean Replace (const Handle< AIS_Animation > &theAnimationOld, const Handle< AIS_Animation > &theAnimationNew)
 Replace the child animation. More...
 
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. More...
 
const NCollection_Sequence< Handle< AIS_Animation > > & Children () const
 Return sequence of child animations. More...
 
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. More...
 
virtual Standard_Real UpdateTimer ()
 Update single frame of animation, update timer state. More...
 
Standard_Real ElapsedTime () const
 Return elapsed time. More...
 
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. More...
 
virtual void Pause ()
 Pause the process timeline. More...
 
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. More...
 
bool IsStopped ()
 Check if animation is to be performed in the animation timeline. More...
 
virtual Standard_Boolean Update (const Standard_Real thePts)
 Update single frame of animation, update timer state. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

virtual void update (const AIS_AnimationProgress &theProgress) override
 Update the progress. More...
 
- 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. More...
 

Protected Attributes

Handle< V3d_ViewmyView
 view to setup camera More...
 
Handle< Graphic3d_CameramyCamStart
 starting camera position More...
 
Handle< Graphic3d_CameramyCamEnd
 end camera position More...
 
- Protected Attributes inherited from AIS_Animation
Handle< AIS_AnimationTimermyTimer
 
TCollection_AsciiString myName
 animation name More...
 
NCollection_Sequence< Handle< AIS_Animation > > myAnimations
 sequence of child animations More...
 
AnimationState myState
 animation state - started, stopped of paused More...
 
Standard_Real myPtsStart
 time of start in the timeline More...
 
Standard_Real myOwnDuration
 duration of animation excluding children More...
 
Standard_Real myChildrenDuration
 duration of animation including children More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Types inherited from AIS_Animation
enum  AnimationState { AnimationState_Started, AnimationState_Stopped, AnimationState_Paused }
 Defines animation state. More...
 

Detailed Description

Camera animation.

Constructor & Destructor Documentation

◆ AIS_AnimationCamera()

AIS_AnimationCamera::AIS_AnimationCamera ( const TCollection_AsciiString theAnimationName,
const Handle< V3d_View > &  theView 
)

Main constructor.

Member Function Documentation

◆ CameraEnd()

const Handle< Graphic3d_Camera >& AIS_AnimationCamera::CameraEnd ( ) const
inline

Return camera end position.

◆ CameraStart()

const Handle< Graphic3d_Camera >& AIS_AnimationCamera::CameraStart ( ) const
inline

Return camera start position.

◆ SetCameraEnd()

void AIS_AnimationCamera::SetCameraEnd ( const Handle< Graphic3d_Camera > &  theCameraEnd)
inline

Define camera end position.

◆ SetCameraStart()

void AIS_AnimationCamera::SetCameraStart ( const Handle< Graphic3d_Camera > &  theCameraStart)
inline

Define camera start position.

◆ update()

virtual void AIS_AnimationCamera::update ( const AIS_AnimationProgress theProgress)
overrideprotectedvirtual

Update the progress.

Reimplemented from AIS_Animation.

◆ View()

const Handle< V3d_View >& AIS_AnimationCamera::View ( ) const
inline

Return the target view.

Field Documentation

◆ myCamEnd

Handle< Graphic3d_Camera > AIS_AnimationCamera::myCamEnd
protected

end camera position

◆ myCamStart

Handle< Graphic3d_Camera > AIS_AnimationCamera::myCamStart
protected

starting camera position

◆ myView

Handle< V3d_View > AIS_AnimationCamera::myView
protected

view to setup camera


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