openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::ProxyNode Class Reference
Inheritance diagram for osg::ProxyNode:
osg::Group osg::Node osg::Object osg::Referenced

Public Types

enum  CenterMode { USE_BOUNDING_SPHERE_CENTER, USER_DEFINED_CENTER }
 
enum  LoadingExternalReferenceMode { LOAD_IMMEDIATELY, DEFER_LOADING_TO_DATABASE_PAGER, NO_AUTOMATIC_LOADING }
 
typedef
osg::BoundingSphere::vec_type 
vec_type
 
typedef
osg::BoundingSphere::value_type 
value_type
 

Public Member Functions

 ProxyNode ()
 
 ProxyNode (const ProxyNode &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, ProxyNode)
 
virtual void traverse (NodeVisitor &nv)
 
virtual bool addChild (Node *child)
 
virtual bool addChild (Node *child, const std::string &filename)
 
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 
void setDatabaseOptions (osg::Referenced *options)
 
osg::ReferencedgetDatabaseOptions ()
 
const osg::ReferencedgetDatabaseOptions () const
 
void setDatabasePath (const std::string &path)
 
const std::string & getDatabasePath () const
 
void setFileName (unsigned int childNo, const std::string &filename)
 
const std::string & getFileName (unsigned int childNo) const
 
unsigned int getNumFileNames () const
 
osg::ref_ptr< osg::Referenced > & getDatabaseRequest (unsigned int childNo)
 
const osg::ref_ptr
< osg::Referenced > & 
getDatabaseRequest (unsigned int childNo) const
 
void setCenterMode (CenterMode mode)
 
CenterMode getCenterMode () const
 
void setLoadingExternalReferenceMode (LoadingExternalReferenceMode mode)
 
LoadingExternalReferenceMode getLoadingExternalReferenceMode () const
 
void setCenter (const Vec3 &center)
 
const vec_typegetCenter () const
 
void setRadius (value_type radius)
 
value_type getRadius () const
 
virtual BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Group)
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual bool insertChild (unsigned int index, Node *child)
 
bool removeChild (Node *child)
 
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 
virtual bool replaceChild (Node *origChild, Node *newChild)
 
unsigned int getNumChildren () const
 
virtual bool setChild (unsigned int i, Node *node)
 
NodegetChild (unsigned int i)
 
const NodegetChild (unsigned int i) const
 
bool containsNode (const Node *node) const
 
unsigned int getChildIndex (const Node *node) const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (NodeCallback *nc)
 
NodeCallbackgetUpdateCallback ()
 
const NodeCallbackgetUpdateCallback () const
 
void addUpdateCallback (NodeCallback *nc)
 
void removeUpdateCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (NodeCallback *nc)
 
NodeCallbackgetEventCallback ()
 
const NodeCallbackgetEventCallback () const
 
void addEventCallback (NodeCallback *nc)
 
void removeEventCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (NodeCallback *nc)
 
NodeCallbackgetCullCallback ()
 
const NodeCallbackgetCullCallback () const
 
void addCullCallback (NodeCallback *nc)
 
void removeCullCallback (NodeCallback *nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
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)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
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)
 
- 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 Types

typedef std::pair< std::string,
osg::ref_ptr< osg::Referenced > > 
FileNameDatabaseRequestPair
 
typedef std::vector
< FileNameDatabaseRequestPair
FileNameDatabaseRequestList
 

Protected Member Functions

virtual ~ProxyNode ()
 
void expandFileNameListTo (unsigned int pos)
 
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
 
virtual void childRemoved (unsigned int, unsigned int)
 
virtual void childInserted (unsigned int)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *node)
 
void removeParent (osg::Group *node)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- 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

FileNameDatabaseRequestList _filenameList
 
ref_ptr< Referenced_databaseOptions
 
std::string _databasePath
 
LoadingExternalReferenceMode _loadingExtReference
 
CenterMode _centerMode
 
vec_type _userDefinedCenter
 
value_type _radius
 
- Protected Attributes inherited from osg::Group
NodeList _children
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< NodeCallback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< NodeCallback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< NodeCallback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- 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

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

ProxyNode.

Member Typedef Documentation

typedef std::pair< std::string, osg::ref_ptr<osg::Referenced> > osg::ProxyNode::FileNameDatabaseRequestPair
protected

Member Enumeration Documentation

Modes which control how the center of object should be determined when computed which child is active.

Enumerator:
USE_BOUNDING_SPHERE_CENTER 
USER_DEFINED_CENTER 

Modes which control how the proxynode external reference are loaded.

Enumerator:
LOAD_IMMEDIATELY 
DEFER_LOADING_TO_DATABASE_PAGER 
NO_AUTOMATIC_LOADING 

Constructor & Destructor Documentation

osg::ProxyNode::ProxyNode ( )
osg::ProxyNode::ProxyNode ( const ProxyNode ,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::ProxyNode::~ProxyNode ( )
inlineprotectedvirtual

Member Function Documentation

virtual bool osg::ProxyNode::addChild ( Node child)
virtual

Add Node to Group. If node is not NULL and is not contained in Group then increment its reference count, add it to the child list and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. Otherwise return false. Scene nodes can't be added as child nodes.

Reimplemented from osg::Group.

virtual bool osg::ProxyNode::addChild ( Node child,
const std::string &  filename 
)
virtual
virtual BoundingSphere osg::ProxyNode::computeBound ( ) const
virtual

Compute the bounding sphere around Node's geometry or children. This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

void osg::ProxyNode::expandFileNameListTo ( unsigned int  pos)
protected
const vec_type& osg::ProxyNode::getCenter ( ) const
inline

return the ProxyNode center point.

CenterMode osg::ProxyNode::getCenterMode ( ) const
inline

Get how the center of object should be determined when computed which child is active.

osg::Referenced* osg::ProxyNode::getDatabaseOptions ( )
inline

Get the optional database osgDB::Options object used when loaded children.

const osg::Referenced* osg::ProxyNode::getDatabaseOptions ( ) const
inline

Get the optional database osgDB::Options object used when loaded children.

const std::string& osg::ProxyNode::getDatabasePath ( ) const
inline

Get the database path used to prepend to children's filenames.

osg::ref_ptr<osg::Referenced>& osg::ProxyNode::getDatabaseRequest ( unsigned int  childNo)
inline

Return the DatabaseRequest object used by the DatabasePager to keep track of file load requests being carried on behalf of the DatabasePager. Note, in normal OSG usage you should not set this value yourself, as this will be managed by the osgDB::DatabasePager.

const osg::ref_ptr<osg::Referenced>& osg::ProxyNode::getDatabaseRequest ( unsigned int  childNo) const
inline

Return the const DatabaseRequest object.

const std::string& osg::ProxyNode::getFileName ( unsigned int  childNo) const
inline
LoadingExternalReferenceMode osg::ProxyNode::getLoadingExternalReferenceMode ( ) const
inline

Get the setted mode of loading.

unsigned int osg::ProxyNode::getNumFileNames ( ) const
inline
value_type osg::ProxyNode::getRadius ( ) const
inline

Get the object-space radius of the volume enclosed by the ProxyNode.

osg::ProxyNode::META_Node ( osg  ,
ProxyNode   
)
virtual bool osg::ProxyNode::removeChildren ( unsigned int  pos,
unsigned int  numChildrenToRemove 
)
virtual

Remove children from Group. Note, must be override by subclasses of Group which add per child attributes.

Reimplemented from osg::Group.

void osg::ProxyNode::setCenter ( const Vec3 center)
inline

Sets the object-space point which defines the center of the osg::ProxyNode. center is affected by any transforms in the hierarchy above the osg::ProxyNode.

void osg::ProxyNode::setCenterMode ( CenterMode  mode)
inline

Set how the center of object should be determined when computed which child is active.

void osg::ProxyNode::setDatabaseOptions ( osg::Referenced options)
inline

Set the optional database osgDB::Options object to use when loaded children.

void osg::ProxyNode::setDatabasePath ( const std::string &  path)

Set the database path to prepend to children's filenames.

void osg::ProxyNode::setFileName ( unsigned int  childNo,
const std::string &  filename 
)
inline
void osg::ProxyNode::setLoadingExternalReferenceMode ( LoadingExternalReferenceMode  mode)
inline

Set how the child loading is done.

void osg::ProxyNode::setRadius ( value_type  radius)
inline

Set the object-space reference radius of the volume enclosed by the ProxyNode. Used to determine the bounding sphere of the ProxyNode in the absence of any children.

virtual void osg::ProxyNode::traverse ( NodeVisitor )
virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

Member Data Documentation

CenterMode osg::ProxyNode::_centerMode
protected
ref_ptr<Referenced> osg::ProxyNode::_databaseOptions
protected
std::string osg::ProxyNode::_databasePath
protected
FileNameDatabaseRequestList osg::ProxyNode::_filenameList
protected
LoadingExternalReferenceMode osg::ProxyNode::_loadingExtReference
protected
value_type osg::ProxyNode::_radius
protected
vec_type osg::ProxyNode::_userDefinedCenter
protected

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