openscenegraph
osg::ScriptNodeCallback Class Reference

#include <ScriptEngine>

Inheritance diagram for osg::ScriptNodeCallback:
osg::NodeCallback osg::Callback osg::Object osg::Referenced

Public Member Functions

 ScriptNodeCallback (Script *script=0, const std::string &entryPoint="")
 ScriptNodeCallback (const ScriptNodeCallback &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osg, ScriptNodeCallback) void setScript(osg
osg::ScriptgetScript ()
const osg::ScriptgetScript () const
void setEntryPoint (const std::string &script)
const std::string & getEntryPoint () const
osg::ScriptEnginegetScriptEngine (osg::NodePath &nodePath)
virtual void operator() (osg::Node *node, osg::NodeVisitor *nv)
Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
 META_Object (osg, NodeCallback)
virtual NodeCallbackasNodeCallback ()
virtual const NodeCallbackasNodeCallback () const
virtual bool run (osg::Object *object, osg::Object *data)
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 DrawableEventCallbackasDrawableEventCallback ()
virtual const DrawableEventCallbackasDrawableEventCallback () const
virtual DrawableCullCallbackasDrawableCullCallback ()
virtual const DrawableCullCallbackasDrawableCullCallback () const
virtual osgGA::EventHandlerasEventHandler ()
virtual const osgGA::EventHandlerasEventHandler () 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

Protected Member Functions

virtual ~ScriptNodeCallback ()
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

Protected Attributes

osg::ref_ptr< Script_script
std::string _entryPoint
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 ()

Detailed Description

NodeCallback for attaching a script to a NodeCallback so that it can be called as an update or event callback.

Constructor & Destructor Documentation

◆ ScriptNodeCallback() [1/2]

osg::ScriptNodeCallback::ScriptNodeCallback ( Script * script = 0,
const std::string & entryPoint = "" )
inline

References _entryPoint, and _script.

Referenced by META_Object(), and ScriptNodeCallback().

◆ ScriptNodeCallback() [2/2]

osg::ScriptNodeCallback::ScriptNodeCallback ( const ScriptNodeCallback & rhs,
const osg::CopyOp & copyop = osg::CopyOp::SHALLOW_COPY )
inline

◆ ~ScriptNodeCallback()

virtual osg::ScriptNodeCallback::~ScriptNodeCallback ( )
inlineprotectedvirtual

Member Function Documentation

◆ getEntryPoint()

const std::string & osg::ScriptNodeCallback::getEntryPoint ( ) const
inline

Get the script to call.

References _entryPoint.

◆ getScript() [1/2]

osg::Script * osg::ScriptNodeCallback::getScript ( )
inline

Get the script to call.

References _script.

◆ getScript() [2/2]

const osg::Script * osg::ScriptNodeCallback::getScript ( ) const
inline

Get the script to call.

References _script.

◆ getScriptEngine()

osg::ScriptEngine * osg::ScriptNodeCallback::getScriptEngine ( osg::NodePath & nodePath)

find the ScriptEngine from looking at the UserDataContainers of nodes in scene graph above the ScriptCallback.

◆ META_Object()

osg::ScriptNodeCallback::META_Object ( osg ,
ScriptNodeCallback  )
inline

Set the script to call.

References _script, and ScriptNodeCallback().

◆ operator()()

virtual void osg::ScriptNodeCallback::operator() ( osg::Node * node,
osg::NodeVisitor * nv )
virtual

NodeCallback method, calls the Script.

Reimplemented from osg::NodeCallback.

◆ setEntryPoint()

void osg::ScriptNodeCallback::setEntryPoint ( const std::string & script)
inline

Set the entry point to call.

References _entryPoint.

Member Data Documentation

◆ _entryPoint

std::string osg::ScriptNodeCallback::_entryPoint
protected

◆ _script

osg::ref_ptr<Script> osg::ScriptNodeCallback::_script
protected

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