openscenegraph
Public Member Functions | Protected Attributes | List of all members
osgViewer::RecordCameraPathHandler Class Reference

#include <ViewerEventHandlers>

Inheritance diagram for osgViewer::RecordCameraPathHandler:
osgGA::GUIEventHandler osgGA::EventHandler osg::NodeCallback osg::DrawableEventCallback osg::Callback osg::Callback osg::Object osg::Object osg::Referenced osg::Referenced

Public Member Functions

 RecordCameraPathHandler (const std::string &filename="saved_animation.path", float fps=25.0f)
 
void setKeyEventToggleRecord (int key)
 
int getKeyEventToggleRecord () const
 
void setKeyEventTogglePlayback (int key)
 
int getKeyEventTogglePlayback () const
 
void setAutoIncrementFilename (bool autoinc=true)
 
virtual void getUsage (osg::ApplicationUsage &usage) const
 
bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
 
- Public Member Functions inherited from osgGA::GUIEventHandler
 GUIEventHandler ()
 
 GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgGA, GUIEventHandler)
 
virtual bool handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
 
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
 
- Public Member Functions inherited from osgGA::EventHandler
 EventHandler ()
 
 EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgGA, EventHandler)
 
virtual NodeCallbackasNodeCallback ()
 
virtual const NodeCallbackasNodeCallback () const
 
virtual DrawableEventCallbackasDrawableEventCallback ()
 
virtual const DrawableEventCallbackasDrawableEventCallback () const
 
virtual EventHandlerasEventHandler ()
 
virtual const EventHandlerasEventHandler () const
 
virtual bool run (osg::Object *object, osg::Object *data)
 
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
 
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
 
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 
 NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
 
 META_Object (osg, NodeCallback)
 
- Public Member Functions inherited from osg::Callback
 Callback ()
 
 Callback (const Callback &cb, const CopyOp &copyop)
 
 META_Object (osg, Callback)
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual StateAttributeCallbackasStateAttributeCallback ()
 
virtual const StateAttributeCallbackasStateAttributeCallback () const
 
virtual UniformCallbackasUniformCallback ()
 
virtual const UniformCallbackasUniformCallback () const
 
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
 
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
 
virtual DrawableCullCallbackasDrawableCullCallback ()
 
virtual const DrawableCullCallbackasDrawableCullCallback () const
 
bool traverse (osg::Object *object, osg::Object *data)
 
void setNestedCallback (osg::Callback *cb)
 
osg::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () const
 
void addNestedCallback (osg::Callback *nc)
 
void removeNestedCallback (osg::Callback *nc)
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 
virtual const char * className () const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 
- Public Member Functions inherited from osg::DrawableEventCallback
 DrawableEventCallback ()
 
 DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
 
 META_Object (osg, DrawableEventCallback)
 

Protected Attributes

std::string _filename
 
int _autoinc
 
osgDB::ofstream _fout
 
int _keyEventToggleRecord
 
int _keyEventTogglePlayback
 
bool _currentlyRecording
 
bool _currentlyPlaying
 
double _interval
 
double _delta
 
osg::Timer_t _animStartTime
 
osg::Timer_t _lastFrameTime
 
osg::ref_ptr< osg::AnimationPath_animPath
 
osg::ref_ptr< osgGA::AnimationPathManipulator_animPathManipulator
 
osg::ref_ptr< osgGA::CameraManipulator_oldManipulator
 
- Protected Attributes inherited from osg::Callback
ref_ptr< Callback_nestedCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- Protected Member Functions inherited from osgGA::GUIEventHandler
virtual ~GUIEventHandler ()
 
- Protected Member Functions inherited from osg::NodeCallback
virtual ~NodeCallback ()
 
- Protected Member Functions inherited from osg::Callback
virtual ~Callback ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

Event handler allowing the user to record the animation "path" of a camera. In it's current implementation, this handler cannot guarantee the final view matrix is correct; it is conceivable that the matrix may be one frame off. Eh–not a big deal! :) TODO: Write the file as we go, not when it's all done. TODO: Create an osgviewer on-screen indication that animation is taking place.

Constructor & Destructor Documentation

◆ RecordCameraPathHandler()

osgViewer::RecordCameraPathHandler::RecordCameraPathHandler ( const std::string &  filename = "saved_animation.path",
float  fps = 25.0f 
)

Member Function Documentation

◆ getKeyEventTogglePlayback()

int osgViewer::RecordCameraPathHandler::getKeyEventTogglePlayback ( ) const
inline

◆ getKeyEventToggleRecord()

int osgViewer::RecordCameraPathHandler::getKeyEventToggleRecord ( ) const
inline

◆ getUsage()

virtual void osgViewer::RecordCameraPathHandler::getUsage ( osg::ApplicationUsage ) const
virtual

Get the user interface usage of this event handler, i.e. keyboard and mouse bindings.

Reimplemented from osgGA::EventHandler.

◆ handle()

bool osgViewer::RecordCameraPathHandler::handle ( const osgGA::GUIEventAdapter ,
osgGA::GUIActionAdapter  
)
virtual

Deprecated, Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

◆ setAutoIncrementFilename()

void osgViewer::RecordCameraPathHandler::setAutoIncrementFilename ( bool  autoinc = true)
inline

◆ setKeyEventTogglePlayback()

void osgViewer::RecordCameraPathHandler::setKeyEventTogglePlayback ( int  key)
inline

◆ setKeyEventToggleRecord()

void osgViewer::RecordCameraPathHandler::setKeyEventToggleRecord ( int  key)
inline

Member Data Documentation

◆ _animPath

osg::ref_ptr<osg::AnimationPath> osgViewer::RecordCameraPathHandler::_animPath
protected

◆ _animPathManipulator

osg::ref_ptr<osgGA::AnimationPathManipulator> osgViewer::RecordCameraPathHandler::_animPathManipulator
protected

◆ _animStartTime

osg::Timer_t osgViewer::RecordCameraPathHandler::_animStartTime
protected

◆ _autoinc

int osgViewer::RecordCameraPathHandler::_autoinc
protected

◆ _currentlyPlaying

bool osgViewer::RecordCameraPathHandler::_currentlyPlaying
protected

◆ _currentlyRecording

bool osgViewer::RecordCameraPathHandler::_currentlyRecording
protected

◆ _delta

double osgViewer::RecordCameraPathHandler::_delta
protected

◆ _filename

std::string osgViewer::RecordCameraPathHandler::_filename
protected

◆ _fout

osgDB::ofstream osgViewer::RecordCameraPathHandler::_fout
protected

◆ _interval

double osgViewer::RecordCameraPathHandler::_interval
protected

◆ _keyEventTogglePlayback

int osgViewer::RecordCameraPathHandler::_keyEventTogglePlayback
protected

◆ _keyEventToggleRecord

int osgViewer::RecordCameraPathHandler::_keyEventToggleRecord
protected

◆ _lastFrameTime

osg::Timer_t osgViewer::RecordCameraPathHandler::_lastFrameTime
protected

◆ _oldManipulator

osg::ref_ptr<osgGA::CameraManipulator> osgViewer::RecordCameraPathHandler::_oldManipulator
protected

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