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

Event handler allowing the user to record the animation "path" of a camera. More...

Inheritance diagram for osgViewer::RecordCameraPathHandler:
Inheritance graph
[legend]

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
 Get the user interface usage of this event handler, i.e. More...
 
bool handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)
 Deprecated, Handle events, return true if handled, false otherwise. More...
 
- 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)
 Handle event. More...
 
virtual bool handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
 Handle events, return true if handled, false otherwise. More...
 
- 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 bool run (osg::Object *object, osg::Object *data)
 NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method. More...
 
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
 Event traversal node callback method. More...
 
virtual void event (osg::NodeVisitor *nv, osg::Drawable *drawable)
 Event traversal drawable callback method. More...
 
- 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)
 
bool traverse (osg::Object *object, osg::Object *data)
 traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...
 
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 ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 
- Public Member Functions inherited from osg::Drawable::EventCallback
 EventCallback ()
 
 EventCallback (const EventCallback &, const CopyOp &)
 
 META_Object (osg, EventCallback)
 

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::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- 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 ()
 Object destructor. More...
 
- 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

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

Member Function Documentation

int osgViewer::RecordCameraPathHandler::getKeyEventTogglePlayback ( ) const
inline
int osgViewer::RecordCameraPathHandler::getKeyEventToggleRecord ( ) const
inline
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.

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

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

Reimplemented from osgGA::GUIEventHandler.

void osgViewer::RecordCameraPathHandler::setAutoIncrementFilename ( bool  autoinc = true)
inline
void osgViewer::RecordCameraPathHandler::setKeyEventTogglePlayback ( int  key)
inline
void osgViewer::RecordCameraPathHandler::setKeyEventToggleRecord ( int  key)
inline

Member Data Documentation

osg::ref_ptr<osg::AnimationPath> osgViewer::RecordCameraPathHandler::_animPath
protected
osg::ref_ptr<osgGA::AnimationPathManipulator> osgViewer::RecordCameraPathHandler::_animPathManipulator
protected
osg::Timer_t osgViewer::RecordCameraPathHandler::_animStartTime
protected
int osgViewer::RecordCameraPathHandler::_autoinc
protected
bool osgViewer::RecordCameraPathHandler::_currentlyPlaying
protected
bool osgViewer::RecordCameraPathHandler::_currentlyRecording
protected
double osgViewer::RecordCameraPathHandler::_delta
protected
std::string osgViewer::RecordCameraPathHandler::_filename
protected
osgDB::ofstream osgViewer::RecordCameraPathHandler::_fout
protected
double osgViewer::RecordCameraPathHandler::_interval
protected
int osgViewer::RecordCameraPathHandler::_keyEventTogglePlayback
protected
int osgViewer::RecordCameraPathHandler::_keyEventToggleRecord
protected
osg::Timer_t osgViewer::RecordCameraPathHandler::_lastFrameTime
protected
osg::ref_ptr<osgGA::CameraManipulator> osgViewer::RecordCameraPathHandler::_oldManipulator
protected

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

osg logo
Generated at Wed Nov 11 2015 22:15:21 for the OpenSceneGraph by doxygen 1.8.10.