#include <ProxyNode.h>

Inheritance diagram for osg::ProxyNode:

Collaboration diagram for osg::ProxyNode:

Public Types
enum	CenterMode { USE_BOUNDING_SPHERE_CENTER, USER_DEFINED_CENTER, UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED }

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 Types inherited from osg::Node
typedef std::vector< Group * >	ParentList

typedef unsigned int	NodeMask

typedef std::vector< std::string >	DescriptionList

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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::Referenced *	getDatabaseOptions ()

const osg::Referenced *	getDatabaseOptions () 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 vec_type &center)

const vec_type &	getCenter () 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 Group *	asGroup ()

virtual const Group *	asGroup () const

virtual bool	insertChild (unsigned int index, Node *child)

virtual bool	removeChild (Node *child)

bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)

virtual bool	replaceChild (Node origChild, Node newChild)

virtual unsigned int	getNumChildren () const

virtual bool	setChild (unsigned int i, Node *node)

Node *	getChild (unsigned int i)

const Node *	getChild (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 Object *	cloneType () const

virtual Object *	clone (const CopyOp &copyop) const

virtual bool	isSameKindAs (const Object *obj) const

virtual const char *	libraryName () const

virtual const char *	className () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual Drawable *	asDrawable ()

virtual const Drawable *	asDrawable () const

virtual Geometry *	asGeometry ()

virtual const Geometry *	asGeometry () const

virtual Transform *	asTransform ()

virtual const Transform *	asTransform () const

virtual Camera *	asCamera ()

virtual const Camera *	asCamera () const

virtual Switch *	asSwitch ()

virtual const Switch *	asSwitch () const

virtual Geode *	asGeode ()

virtual const Geode *	asGeode () const

virtual osgTerrain::Terrain *	asTerrain ()

virtual const osgTerrain::Terrain *	asTerrain () const

virtual void	accept (NodeVisitor &nv)

virtual void	ascend (NodeVisitor &nv)

const ParentList &	getParents () const

ParentList	getParents ()

Group *	getParent (unsigned int i)

const Group *	getParent (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 (Callback *nc)

Callback *	getUpdateCallback ()

const Callback *	getUpdateCallback () const

void	addUpdateCallback (Callback *nc)

void	removeUpdateCallback (Callback *nc)

unsigned int	getNumChildrenRequiringUpdateTraversal () const

void	setEventCallback (Callback *nc)

Callback *	getEventCallback ()

const Callback *	getEventCallback () const

void	addEventCallback (Callback *nc)

void	removeEventCallback (Callback *nc)

unsigned int	getNumChildrenRequiringEventTraversal () const

void	setCullCallback (Callback *nc)

Callback *	getCullCallback ()

const Callback *	getCullCallback () const

void	addCullCallback (Callback *nc)

void	removeCullCallback (Callback *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::StateSet *	getOrCreateStateSet ()

osg::StateSet *	getStateSet ()

const osg::StateSet *	getStateSet () const

void	setDescriptions (const DescriptionList &descriptions)

DescriptionList &	getDescriptions ()

const DescriptionList &	getDescriptions () 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 BoundingSphere &	getInitialBound () const

void	dirtyBound ()

const BoundingSphere &	getBound () const

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const

Public Member Functions inherited from osg::Object
	Object ()

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () 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)

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 &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () 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 *parent)

void	removeParent (osg::Group *parent)

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< Callback >	_updateCallback

unsigned int	_numChildrenRequiringUpdateTraversal

ref_ptr< Callback >	_eventCallback

unsigned int	_numChildrenRequiringEventTraversal

ref_ptr< Callback >	_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::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

Detailed Description

ProxyNode.

Definition at line 23 of file ProxyNode.h.

Member Typedef Documentation

typedef std::vector<FileNameDatabaseRequestPair> osg::ProxyNode::FileNameDatabaseRequestList

protected

Definition at line 126 of file ProxyNode.h.

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

protected

Definition at line 125 of file ProxyNode.h.

typedef osg::BoundingSphere::value_type osg::ProxyNode::value_type

Definition at line 35 of file ProxyNode.h.

typedef osg::BoundingSphere::vec_type osg::ProxyNode::vec_type

Definition at line 34 of file ProxyNode.h.

Member Enumeration Documentation

enum osg::ProxyNode::CenterMode

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

Enumerator
USE_BOUNDING_SPHERE_CENTER
USER_DEFINED_CENTER
UNION_OF_BOUNDING_SPHERE_AND_USER_DEFINED

Definition at line 75 of file ProxyNode.h.

enum osg::ProxyNode::LoadingExternalReferenceMode

Modes which control how the proxynode external reference are loaded.

Enumerator
LOAD_IMMEDIATELY
DEFER_LOADING_TO_DATABASE_PAGER
NO_AUTOMATIC_LOADING

Definition at line 89 of file ProxyNode.h.

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

Definition at line 121 of file ProxyNode.h.

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.

Definition at line 107 of file ProxyNode.h.

CenterMode osg::ProxyNode::getCenterMode ( ) const

inline

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

Definition at line 86 of file ProxyNode.h.

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

inline

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

Definition at line 49 of file ProxyNode.h.

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

inline

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

Definition at line 52 of file ProxyNode.h.

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

inline

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

Definition at line 58 of file ProxyNode.h.

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 out 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.

Definition at line 68 of file ProxyNode.h.

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

inline

Return the const DatabaseRequest object.

Definition at line 71 of file ProxyNode.h.

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

inline

Definition at line 61 of file ProxyNode.h.

LoadingExternalReferenceMode osg::ProxyNode::getLoadingExternalReferenceMode ( ) const

inline

Get the loading mode.

Definition at line 100 of file ProxyNode.h.

unsigned int osg::ProxyNode::getNumFileNames ( ) const

inline

Definition at line 62 of file ProxyNode.h.

value_type osg::ProxyNode::getRadius ( ) const

inline

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

Definition at line 115 of file ProxyNode.h.

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 vec_type & 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.

Definition at line 104 of file ProxyNode.h.

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

inline

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

Definition at line 83 of file ProxyNode.h.

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

inline

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

Definition at line 46 of file ProxyNode.h.

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

Definition at line 60 of file ProxyNode.h.

void osg::ProxyNode::setLoadingExternalReferenceMode ( LoadingExternalReferenceMode mode )

inline

Set how the child loading is done.

Definition at line 97 of file ProxyNode.h.

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.

Definition at line 112 of file ProxyNode.h.

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

Definition at line 134 of file ProxyNode.h.

ref_ptr<Referenced> osg::ProxyNode::_databaseOptions

protected

Definition at line 129 of file ProxyNode.h.

std::string osg::ProxyNode::_databasePath

protected

Definition at line 130 of file ProxyNode.h.

FileNameDatabaseRequestList osg::ProxyNode::_filenameList

protected

Definition at line 128 of file ProxyNode.h.

LoadingExternalReferenceMode osg::ProxyNode::_loadingExtReference

protected

Definition at line 132 of file ProxyNode.h.

value_type osg::ProxyNode::_radius

protected

Definition at line 136 of file ProxyNode.h.

vec_type osg::ProxyNode::_userDefinedCenter

protected

Definition at line 135 of file ProxyNode.h.

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

osg_head/include/osg/ProxyNode.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation