OpenSceneGraph/doc/doc++/osg/Node.html

674 lines
36 KiB
HTML
Raw Normal View History

2003-04-18 00:22:51 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class SG_EXPORT osg::Node</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::Node</A></H2></H2><BLOCKQUOTE>Base class for all internal nodes in the scene graph.</BLOCKQUOTE>
<HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=155>
<param name=classes value="CReferenced,MReferenced.html,CObject,MObject.html,CNode,MNode.html,CGroup,MGroup.html,CGeode,MGeode.html">
<param name=before value="M,M,M,M|_,Mr_">
<param name=after value="Md_SP,Md_,M,M,M">
<param name=indent value="0,1,2,2,2">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.119.1">Node</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Construct a node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.119.2">Node</A></B>(const <!1><A HREF="Node.html#DOC.2.119.2">Node</A>&amp;, const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop=CopyOp::SHALLOW_COPY)
2003-04-18 00:22:51 +08:00
<DD><I>Copy constructor using CopyOp to manage deep vs shallow copy</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="Object.html">Object</A>* <B><A HREF="#DOC.2.119.3">cloneType</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>clone the an object of the same type as the node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="Object.html">Object</A>* <B><A HREF="#DOC.2.119.4">clone</A></B>(const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop) const
2003-04-18 00:22:51 +08:00
<DD><I>return a clone of a node, with Object* return type</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual bool <B><A HREF="#DOC.2.119.5">isSameKindAs</A></B>(const <!1><A HREF="Object.html">Object</A>* obj) const
2003-04-18 00:22:51 +08:00
<DD><I>return true if this and obj are of the same kind of object</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const char* <B><A HREF="#DOC.2.119.6">libraryName</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>return the name of the node's library</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const char* <B><A HREF="#DOC.2.119.7">className</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>return the name of the node's class type</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="Group.html">Group</A>* <B><A HREF="#DOC.2.119.8">asGroup</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>convert 'this' into a Group pointer if Node is a Group, otherwise return 0.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const <!1><A HREF="Group.html">Group</A>* <B><A HREF="#DOC.2.119.9">asGroup</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <!1><A HREF="Transform.html">Transform</A>* <B><A HREF="#DOC.2.119.10">asTransform</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual const <!1><A HREF="Transform.html">Transform</A>* <B><A HREF="#DOC.2.119.11">asTransform</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.119.12">accept</A></B>(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; nv)
2003-04-18 00:22:51 +08:00
<DD><I>Visitor Pattern : calls the apply method of a NodeVisitor with this node's type</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.119.13">ascend</A></B>(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; nv)
2003-04-18 00:22:51 +08:00
<DD><I>Traverse upwards : calls parents' accept method with NodeVisitor</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual void <B><A HREF="#DOC.2.119.14">traverse</A></B>(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; )
2003-04-18 00:22:51 +08:00
<DD><I>Traverse downwards : calls children's accept method with NodeVisitor</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.119.15">setName</A></B>( const std::string&amp; <!1><A HREF="Test.html#DOC.202.1.3">name</A> )
2003-04-18 00:22:51 +08:00
<DD><I>Set the name of node using C++ style string</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.119.16">setName</A></B>( const char* <!1><A HREF="Test.html#DOC.202.1.3">name</A> )
2003-04-18 00:22:51 +08:00
<DD><I>Set the name of node using a C style string</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const std::string&amp; <B><A HREF="#DOC.2.119.17">getName</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the name of node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Node.html#DOC.2.119.18">ParentList</A>&amp; <B><A HREF="#DOC.2.119.19">getParents</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the parent list of node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Node.html#DOC.2.119.18">ParentList</A> <B><A HREF="#DOC.2.119.20">getParents</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Get the a copy of parent list of node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Group.html">Group</A>* <B><A HREF="#DOC.2.119.21">getParent</A></B>(unsigned int i)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Group.html">Group</A>* <B><A HREF="#DOC.2.119.22">getParent</A></B>(unsigned int i) const
2003-04-18 00:22:51 +08:00
<DD><I> Get a single const parent of node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.119.23">getNumParents</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I> Get the number of parents of node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.24">setUpdateCallback</A></B>(<!1><A HREF="NodeCallback.html">NodeCallback</A>* nc)
2003-04-18 00:22:51 +08:00
<DD><I>Set update node callback, called during update traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="NodeCallback.html">NodeCallback</A>* <B><A HREF="#DOC.2.119.25">getUpdateCallback</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Get update node callback, called during update traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="NodeCallback.html">NodeCallback</A>* <B><A HREF="#DOC.2.119.26">getUpdateCallback</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get const update node callback, called during update traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.119.27">getNumChildrenRequiringUpdateTraversal</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the number of Children of this node which require App traversal, since they have an AppCallback attached to them or their children</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.28">setCullCallback</A></B>(<!1><A HREF="NodeCallback.html">NodeCallback</A>* nc)
2003-04-18 00:22:51 +08:00
<DD><I>Set cull node callback, called during cull traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="NodeCallback.html">NodeCallback</A>* <B><A HREF="#DOC.2.119.29">getCullCallback</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Get cull node callback, called during cull traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="NodeCallback.html">NodeCallback</A>* <B><A HREF="#DOC.2.119.30">getCullCallback</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get const cull node callback, called during cull traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.31">setCullingActive</A></B>(bool active)
2003-04-18 00:22:51 +08:00
<DD><I>Set the view frustum/small feature culling of this node to be active or inactive.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.119.32">getCullingActive</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the view frustum/small feature _cullingActive flag for this node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.119.33">getNumChildrenWithCullingDisabled</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the number of Children of this node which have culling disabled</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.119.34">isCullingActive</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.119.35">getNumChildrenWithOccluderNodes</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the number of Children of this node which are or have OccluderNode's</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.119.36">containsOccluderNodes</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.119.38">setNodeMask</A></B>(<!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> nm)
2003-04-18 00:22:51 +08:00
<DD><I>Set the node mask.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> <B><A HREF="#DOC.2.119.39">getNodeMask</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the node Mask.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A>&amp; <B><A HREF="#DOC.2.119.41">getDescriptions</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the description list of the const node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A>&amp; <B><A HREF="#DOC.2.119.42">getDescriptions</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Get the description list of the const node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const std::string&amp; <B><A HREF="#DOC.2.119.43">getDescription</A></B>(unsigned int i) const
2003-04-18 00:22:51 +08:00
<DD><I>Get a single const description of the const node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline std::string&amp; <B><A HREF="#DOC.2.119.44">getDescription</A></B>(unsigned int i)
2003-04-18 00:22:51 +08:00
<DD><I>Get a single description of the node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline unsigned int <B><A HREF="#DOC.2.119.45">getNumDescriptions</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Get the number of descriptions of the node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.46">addDescription</A></B>(const std::string&amp; desc)
2003-04-18 00:22:51 +08:00
<DD><I>Add a description string to the node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.119.47">setStateSet</A></B>(<!1><A HREF="StateSet.html">osg::StateSet</A>* dstate)
2003-04-18 00:22:51 +08:00
<DD><I>set the node's StateSet</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="StateSet.html">osg::StateSet</A>* <B><A HREF="#DOC.2.119.48">getOrCreateStateSet</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="StateSet.html">osg::StateSet</A>* <B><A HREF="#DOC.2.119.49">getStateSet</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>return the node's StateSet.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="StateSet.html">osg::StateSet</A>* <B><A HREF="#DOC.2.119.50">getStateSet</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>return the node's const StateSet.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; <B><A HREF="#DOC.2.119.51">getBound</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>get the bounding sphere of node.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.52">dirtyBound</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Mark this node's bounding sphere dirty.</I>
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef std::vector&lt;<!1><A HREF="Group.html">Group</A>*&gt; <B><A HREF="#DOC.2.119.18">ParentList</A></B>
2003-04-18 00:22:51 +08:00
<DD><I>A vector of osg::Group pointers which is used to store the parent(s) of node</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef unsigned int <B><A HREF="#DOC.2.119.37">NodeMask</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef std::vector&lt;std::string&gt; <B><A HREF="#DOC.2.119.40">DescriptionList</A></B>
2003-04-18 00:22:51 +08:00
<DD><I>A vector of std::string's which are used to describe the object</I>
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>mutable <!1><A HREF="BoundingSphere.html">BoundingSphere</A> <B><A HREF="#DOC.2.119.55">_bsphere</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>mutable bool <B><A HREF="#DOC.2.119.56">_bsphere_computed</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::string <B><A HREF="#DOC.2.119.57">_name</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Node.html#DOC.2.119.18">ParentList</A> <B><A HREF="#DOC.2.119.60">_parents</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="NodeCallback.html">NodeCallback</A>&gt; <B><A HREF="#DOC.2.119.61">_updateCallback</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.119.62">_numChildrenRequiringUpdateTraversal</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="NodeCallback.html">NodeCallback</A>&gt; <B><A HREF="#DOC.2.119.64">_cullCallback</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.119.65">_cullingActive</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.119.66">_numChildrenWithCullingDisabled</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>unsigned int <B><A HREF="#DOC.2.119.68">_numChildrenWithOccluderNodes</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> <B><A HREF="#DOC.2.119.70">_nodeMask</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A> <B><A HREF="#DOC.2.119.71">_descriptions</A></B>
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="StateSet.html">StateSet</A>&gt; <B><A HREF="#DOC.2.119.72">_stateset</A></B>
2003-04-18 00:22:51 +08:00
</DL></P>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.119.53">~Node</A></B>()
2003-04-18 00:22:51 +08:00
<DD><I>Node destructor.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual bool <B><A HREF="#DOC.2.119.54">computeBound</A></B>() const
2003-04-18 00:22:51 +08:00
<DD><I>Compute the bounding sphere around Node's geometry or children.</I>
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.58">addParent</A></B>(<!1><A HREF="Group.html">osg::Group</A>* node)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.59">removeParent</A></B>(<!1><A HREF="Group.html">osg::Group</A>* node)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.63">setNumChildrenRequiringUpdateTraversal</A></B>(unsigned int num)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.67">setNumChildrenWithCullingDisabled</A></B>(unsigned int num)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.119.69">setNumChildrenWithOccluderNodes</A></B>(unsigned int num)
2003-04-18 00:22:51 +08:00
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Object.html">Object</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="o" SRC=icon2.gif>inline void <B>setDataVariance</B>(<!1><A HREF="Object.html#DOC.2.136.8">DataVariance</A> dv)
2003-04-18 00:22:51 +08:00
<DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Object.html#DOC.2.136.8">DataVariance</A> <B>getDataVariance</B>() const
2003-04-18 00:22:51 +08:00
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>setUserData</B>(<!1><A HREF="Referenced.html">Referenced</A>* obj)
<DT>
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Referenced.html">Referenced</A>* <B>getUserData</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const <!1><A HREF="Referenced.html">Referenced</A>* <B>getUserData</B>() const
</DL></P>
<P><DL>
<DT><H3>Public Members</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>enum <B>DataVariance</B>
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
2003-10-02 22:28:30 +08:00
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="Object.html#DOC.2.136.8">DataVariance</A> <B>_dataVariance</B>
2003-04-18 00:22:51 +08:00
<DT>
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="Referenced.html">Referenced</A>&gt; <B>_userData</B>
</DL></P>
</DL>
<HR><H3>Inherited from <A HREF="Referenced.html">Referenced</A>:</H3>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>inline <!1><A HREF="Referenced.html">Referenced</A>&amp; <B>operator = </B>(<!1><A HREF="Referenced.html">Referenced</A>&amp;)
<DT>
<IMG ALT="o" SRC=icon2.gif>static void <B>setDeleteHandler</B>(<!1><A HREF="DeleteHandler.html">DeleteHandler</A>* handler)
<DT>
<IMG ALT="o" SRC=icon2.gif>static <!1><A HREF="DeleteHandler.html">DeleteHandler</A>* <B>getDeleteHandler</B>()
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>ref</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref_nodelete</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline int <B>referenceCount</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline void <B>unref</B>() const
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>mutable int <B>_refCount</B>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>Base class for all internal nodes in the scene graph.
Provides interface for most common node operations (Composite Pattern).</BLOCKQUOTE>
<DL>
<A NAME="Node"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.1"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Node()</B></TT>
<DD>Construct a node.
Initialize the parent list to empty, node name to "" and
bounding sphere dirty flag to true.
<DL><DT><DD></DL><P>
<A NAME="Node"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Node(const <!1><A HREF="Node.html#DOC.2.119.2">Node</A>&amp;, const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop=CopyOp::SHALLOW_COPY)</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Copy constructor using CopyOp to manage deep vs shallow copy
<DL><DT><DD></DL><P>
<A NAME="cloneType"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.3"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="Object.html">Object</A>* cloneType() const </B></TT>
<DD>clone the an object of the same type as the node
<DL><DT><DD></DL><P>
<A NAME="clone"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.4"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="Object.html">Object</A>* clone(const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop) const </B></TT>
<DD>return a clone of a node, with Object* return type
<DL><DT><DD></DL><P>
<A NAME="isSameKindAs"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.5"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual bool isSameKindAs(const <!1><A HREF="Object.html">Object</A>* obj) const </B></TT>
<DD>return true if this and obj are of the same kind of object
<DL><DT><DD></DL><P>
<A NAME="libraryName"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.6"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const char* libraryName() const </B></TT>
<DD>return the name of the node's library
<DL><DT><DD></DL><P>
<A NAME="className"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.7"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const char* className() const </B></TT>
<DD>return the name of the node's class type
<DL><DT><DD></DL><P>
<A NAME="asGroup"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.8"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="Group.html">Group</A>* asGroup()</B></TT>
<DD>convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
Equivalent to dynamic_cast<Group*>(this).
<DL><DT><DD></DL><P>
<A NAME="asGroup"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.9"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const <!1><A HREF="Group.html">Group</A>* asGroup() const </B></TT>
<DD>convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
Equivalent to dynamic_cast<const Group*>(this).
<DL><DT><DD></DL><P>
<A NAME="asTransform"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.10"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual <!1><A HREF="Transform.html">Transform</A>* asTransform()</B></TT>
<DD>convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
Equivalent to dynamic_cast<Transform*>(this).
<DL><DT><DD></DL><P>
<A NAME="asTransform"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.11"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual const <!1><A HREF="Transform.html">Transform</A>* asTransform() const </B></TT>
<DD>convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
Equivalent to dynamic_cast<const Transform*>(this).
<DL><DT><DD></DL><P>
<A NAME="accept"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.12"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void accept(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; nv)</B></TT>
<DD>Visitor Pattern : calls the apply method of a NodeVisitor with this node's type
<DL><DT><DD></DL><P>
<A NAME="ascend"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.13"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void ascend(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; nv)</B></TT>
<DD>Traverse upwards : calls parents' accept method with NodeVisitor
<DL><DT><DD></DL><P>
<A NAME="traverse"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.14"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual void traverse(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; )</B></TT>
<DD>Traverse downwards : calls children's accept method with NodeVisitor
<DL><DT><DD></DL><P>
<A NAME="setName"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setName( const std::string&amp; <!1><A HREF="Test.html#DOC.202.1.3">name</A> )</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Set the name of node using C++ style string
<DL><DT><DD></DL><P>
<A NAME="setName"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setName( const char* <!1><A HREF="Test.html#DOC.202.1.3">name</A> )</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Set the name of node using a C style string
<DL><DT><DD></DL><P>
<A NAME="getName"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.17"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const std::string&amp; getName() const </B></TT>
<DD>Get the name of node
<DL><DT><DD></DL><P>
<A NAME="ParentList"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.18"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef std::vector&lt;<!1><A HREF="Group.html">Group</A>*&gt; ParentList</B></TT>
<DD>A vector of osg::Group pointers which is used to store the parent(s) of node
<DL><DT><DD></DL><P>
<A NAME="getParents"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Node.html#DOC.2.119.18">ParentList</A>&amp; getParents() const </B></TT>
2003-04-18 00:22:51 +08:00
<DD>Get the parent list of node.
<DL><DT><DD></DL><P>
<A NAME="getParents"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Node.html#DOC.2.119.18">ParentList</A> getParents()</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Get the a copy of parent list of node. A copy is returned to
prevent modification of the parent list.
<DL><DT><DD></DL><P>
<A NAME="getParent"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.21"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Group.html">Group</A>* getParent(unsigned int i)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getParent"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.22"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Group.html">Group</A>* getParent(unsigned int i) const </B></TT>
<DD>
Get a single const parent of node.
2003-07-23 19:27:31 +08:00
<DL><DT><DT><B>Parameters:</B><DD><B>i</B> - <!1><A HREF="TemplateIndexArray.html#DOC.2.10.15">index</A> of the parent to get.
2003-04-18 00:22:51 +08:00
<BR><DT><B>Returns:</B><DD> the parent i.<BR><DD></DL><P>
<A NAME="getNumParents"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.23"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getNumParents() const </B></TT>
<DD>
Get the number of parents of node.
<DL><DT><DT><B>Returns:</B><DD> the number of parents of this node.<BR><DD></DL><P>
<A NAME="setUpdateCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.24"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setUpdateCallback(<!1><A HREF="NodeCallback.html">NodeCallback</A>* nc)</B></TT>
<DD>Set update node callback, called during update traversal.
<DL><DT><DD></DL><P>
<A NAME="getUpdateCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.25"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="NodeCallback.html">NodeCallback</A>* getUpdateCallback()</B></TT>
<DD>Get update node callback, called during update traversal.
<DL><DT><DD></DL><P>
<A NAME="getUpdateCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.26"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="NodeCallback.html">NodeCallback</A>* getUpdateCallback() const </B></TT>
<DD>Get const update node callback, called during update traversal.
<DL><DT><DD></DL><P>
<A NAME="getNumChildrenRequiringUpdateTraversal"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.27"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getNumChildrenRequiringUpdateTraversal() const </B></TT>
<DD>Get the number of Children of this node which require App traversal,
since they have an AppCallback attached to them or their children
<DL><DT><DD></DL><P>
<A NAME="setCullCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.28"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setCullCallback(<!1><A HREF="NodeCallback.html">NodeCallback</A>* nc)</B></TT>
<DD>Set cull node callback, called during cull traversal.
<DL><DT><DD></DL><P>
<A NAME="getCullCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.29"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="NodeCallback.html">NodeCallback</A>* getCullCallback()</B></TT>
<DD>Get cull node callback, called during cull traversal.
<DL><DT><DD></DL><P>
<A NAME="getCullCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.30"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="NodeCallback.html">NodeCallback</A>* getCullCallback() const </B></TT>
<DD>Get const cull node callback, called during cull traversal.
<DL><DT><DD></DL><P>
<A NAME="setCullingActive"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.31"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setCullingActive(bool active)</B></TT>
<DD>Set the view frustum/small feature culling of this node to be active or inactive.
The default value to true for _cullingActive. Used a guide
to the cull traversal.
<DL><DT><DD></DL><P>
<A NAME="getCullingActive"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.32"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool getCullingActive() const </B></TT>
<DD>Get the view frustum/small feature _cullingActive flag for this node. Used a guide
to the cull traversal.
<DL><DT><DD></DL><P>
<A NAME="getNumChildrenWithCullingDisabled"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.33"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getNumChildrenWithCullingDisabled() const </B></TT>
<DD>Get the number of Children of this node which have culling disabled
<DL><DT><DD></DL><P>
<A NAME="isCullingActive"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.34"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool isCullingActive() const </B></TT>
<DD>Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
note, return true only if no children have culling disabled, and the local _cullingActive flag is true.
<DL><DT><DD></DL><P>
<A NAME="getNumChildrenWithOccluderNodes"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.35"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getNumChildrenWithOccluderNodes() const </B></TT>
<DD>Get the number of Children of this node which are or have OccluderNode's
<DL><DT><DD></DL><P>
<A NAME="containsOccluderNodes"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.36"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool containsOccluderNodes() const </B></TT>
<DD>return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes
<DL><DT><DD></DL><P>
<A NAME="NodeMask"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.37"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef unsigned int NodeMask</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setNodeMask"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.38"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setNodeMask(<!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> nm)</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Set the node mask. Note, node mask is will be replaced by TraversalMask.
<DL><DT><DD></DL><P>
<A NAME="getNodeMask"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.39"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> getNodeMask() const </B></TT>
2003-04-18 00:22:51 +08:00
<DD>Get the node Mask. Note, node mask is will be replaced by TraversalMask.
<DL><DT><DD></DL><P>
<A NAME="DescriptionList"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.40"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef std::vector&lt;std::string&gt; DescriptionList</B></TT>
<DD>A vector of std::string's which are used to describe the object
<DL><DT><DD></DL><P>
<A NAME="getDescriptions"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.41"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A>&amp; getDescriptions() const </B></TT>
2003-04-18 00:22:51 +08:00
<DD>Get the description list of the const node
<DL><DT><DD></DL><P>
<A NAME="getDescriptions"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.42"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A>&amp; getDescriptions()</B></TT>
2003-04-18 00:22:51 +08:00
<DD>Get the description list of the const node
<DL><DT><DD></DL><P>
<A NAME="getDescription"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.43"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const std::string&amp; getDescription(unsigned int i) const </B></TT>
<DD>Get a single const description of the const node
<DL><DT><DD></DL><P>
<A NAME="getDescription"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.44"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline std::string&amp; getDescription(unsigned int i)</B></TT>
<DD>Get a single description of the node
<DL><DT><DD></DL><P>
<A NAME="getNumDescriptions"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.45"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline unsigned int getNumDescriptions() const </B></TT>
<DD>Get the number of descriptions of the node
<DL><DT><DD></DL><P>
<A NAME="addDescription"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.46"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addDescription(const std::string&amp; desc)</B></TT>
<DD>Add a description string to the node
<DL><DT><DD></DL><P>
<A NAME="setStateSet"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.47"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setStateSet(<!1><A HREF="StateSet.html">osg::StateSet</A>* dstate)</B></TT>
<DD>set the node's StateSet
<DL><DT><DD></DL><P>
<A NAME="getOrCreateStateSet"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.48"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="StateSet.html">osg::StateSet</A>* getOrCreateStateSet()</B></TT>
<DD>return the node's StateSet, if one does not already exist create it
set the node and return the newly created StateSet. This ensures
that a valid StateSet is always returned and can be used directly.
<DL><DT><DD></DL><P>
<A NAME="getStateSet"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.49"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="StateSet.html">osg::StateSet</A>* getStateSet()</B></TT>
<DD>return the node's StateSet. returns NULL if a stateset is not attached.
<DL><DT><DD></DL><P>
<A NAME="getStateSet"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.50"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="StateSet.html">osg::StateSet</A>* getStateSet() const </B></TT>
<DD>return the node's const StateSet. returns NULL if a stateset is not attached.
<DL><DT><DD></DL><P>
<A NAME="getBound"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.51"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="BoundingSphere.html">BoundingSphere</A>&amp; getBound() const </B></TT>
<DD>get the bounding sphere of node.
Using lazy evaluation computes the bounding sphere if it is 'dirty'.
<DL><DT><DD></DL><P>
<A NAME="dirtyBound"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.52"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void dirtyBound()</B></TT>
<DD>Mark this node's bounding sphere dirty.
Forcing it to be computed on the next call to getBound().
<DL><DT><DD></DL><P>
<A NAME="~Node"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.53"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~Node()</B></TT>
<DD>Node destructor. Note, is protected so that Nodes cannot
be deleted other than by being dereferenced and the reference
count being zero (see osg::Referenced), preventing the deletion
of nodes which are still in use. This also means that
Node's cannot be created on stack i.e Node node will not compile,
forcing all nodes to be created on the heap i.e Node* node
= new Node().
<DL><DT><DD></DL><P>
<A NAME="computeBound"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.54"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual bool computeBound() const </B></TT>
<DD>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().
<DL><DT><DD></DL><P>
<A NAME="_bsphere"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.55"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>mutable <!1><A HREF="BoundingSphere.html">BoundingSphere</A> _bsphere</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_bsphere_computed"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.56"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>mutable bool _bsphere_computed</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_name"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.57"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::string _name</B></TT>
<DL><DT><DD></DL><P>
<A NAME="addParent"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.58"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void addParent(<!1><A HREF="Group.html">osg::Group</A>* node)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="removeParent"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.59"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void removeParent(<!1><A HREF="Group.html">osg::Group</A>* node)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_parents"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.60"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Node.html#DOC.2.119.18">ParentList</A> _parents</B></TT>
2003-04-18 00:22:51 +08:00
<DL><DT><DD></DL><P>
<A NAME="_updateCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.61"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="NodeCallback.html">NodeCallback</A>&gt; _updateCallback</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_numChildrenRequiringUpdateTraversal"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.62"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int _numChildrenRequiringUpdateTraversal</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setNumChildrenRequiringUpdateTraversal"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.63"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setNumChildrenRequiringUpdateTraversal(unsigned int num)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_cullCallback"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.64"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="NodeCallback.html">NodeCallback</A>&gt; _cullCallback</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_cullingActive"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.65"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool _cullingActive</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_numChildrenWithCullingDisabled"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.66"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int _numChildrenWithCullingDisabled</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setNumChildrenWithCullingDisabled"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.67"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setNumChildrenWithCullingDisabled(unsigned int num)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_numChildrenWithOccluderNodes"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.68"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>unsigned int _numChildrenWithOccluderNodes</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setNumChildrenWithOccluderNodes"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.69"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setNumChildrenWithOccluderNodes(unsigned int num)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_nodeMask"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.70"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Node.html#DOC.2.119.37">NodeMask</A> _nodeMask</B></TT>
2003-04-18 00:22:51 +08:00
<DL><DT><DD></DL><P>
<A NAME="_descriptions"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.71"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Node.html#DOC.2.119.40">DescriptionList</A> _descriptions</B></TT>
2003-04-18 00:22:51 +08:00
<DL><DT><DD></DL><P>
<A NAME="_stateset"></A>
2003-10-02 22:28:30 +08:00
<A NAME="DOC.2.119.72"></A>
2003-04-18 00:22:51 +08:00
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ref_ptr.html">ref_ptr</A>&lt;<!1><A HREF="StateSet.html">StateSet</A>&gt; _stateset</B></TT>
<DL><DT><DD></DL><P></DL>
<HR>
<DL><DT><B>Direct child classes:
</B><DD><A HREF="Group.html">Group</A><BR>
<A HREF="Geode.html">Geode</A><BR>
</DL>
<DL><DT><DT><B>Friends:</B><DD> class <!1><A HREF="Group.html">osg::Group</A><BR> class <!1><A HREF="Drawable.html">osg::Drawable</A><BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>