OpenSceneGraph 2.8.4
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
osg::ProxyNode Class Reference

ProxyNode. More...

Inheritance diagram for osg::ProxyNode:
Inheritance graph
[legend]

List of all members.

Public Types

enum  CenterMode { USE_BOUNDING_SPHERE_CENTER, USER_DEFINED_CENTER }
 Modes which control how the center of object should be determined when computed which child is active. More...
enum  LoadingExternalReferenceMode { LOAD_IMMEDIATELY, DEFER_LOADING_TO_DATABASE_PAGER, NO_AUTOMATIC_LOADING }
 Modes which control how the proxynode external reference are loaded. More...
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)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, ProxyNode)
virtual void traverse (NodeVisitor &nv)
 Traverse downwards : calls children's accept method with NodeVisitor.
virtual bool addChild (Node *child)
 Add Node to Group.
virtual bool addChild (Node *child, const std::string &filename)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 Remove children from Group.
void setDatabasePath (const std::string &path)
 Set the database path to prepend to children's filenames.
const std::string & getDatabasePath () const
 Get the database path used to prepend to children's filenames.
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)
 Return the DatabaseRequest object used by the DatabasePager to keep track of file load requests being carried on behalf of the DatabasePager.
const osg::ref_ptr
< osg::Referenced > & 
getDatabaseRequest (unsigned int childNo) const
 Return the const DatabaseRequest object.
void setCenterMode (CenterMode mode)
 Set how the center of object should be determined when computed which child is active.
CenterMode getCenterMode () const
 Get how the center of object should be determined when computed which child is active.
void setLoadingExternalReferenceMode (LoadingExternalReferenceMode mode)
 Set how the child loading is done.
LoadingExternalReferenceMode getLoadingExternalReferenceMode () const
 Get the setted mode of loading.
void setCenter (const Vec3 &center)
 Sets the object-space point which defines the center of the osg::ProxyNode.
const vec_typegetCenter () const
 return the ProxyNode center point.
void setRadius (value_type radius)
 Set the object-space reference radius of the volume enclosed by the ProxyNode.
value_type getRadius () const
 Get the object-space radius of the volume enclosed by the ProxyNode.
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.

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 Attributes

FileNameDatabaseRequestList _filenameList
std::string _databasePath
LoadingExternalReferenceMode _loadingExtReference
CenterMode _centerMode
vec_type _userDefinedCenter
value_type _radius

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 ( ) [inline, protected, virtual]

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.

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::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

std::string osg::ProxyNode::_databasePath [protected]

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

osg logo
Generated at Sun Jan 8 2012 13:16:17 for the OpenSceneGraph by doxygen 1.7.4.