H3D API  2.4.1
Public Member Functions | Static Public Attributes | List of all members
H3D::PrototypeInstance Class Reference

The PrototypeInstance is an instance of a prototyped node. More...

#include <H3D/PrototypeInstance.h>

Inheritance diagram for H3D::PrototypeInstance:
Inheritance graph

Public Member Functions

 PrototypeInstance (Node *_prototyped_node, Inst< SFNode > _metadata=0)
 Constructor.
 
virtual Nodeclone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
 Returns a new instance of this node type with the same state as this one. More...
 
- Public Member Functions inherited from H3D::X3DPrototypeInstance
 X3DPrototypeInstance (Inst< SFNode > _metadata=0)
 Constructor.
 
virtual void render ()
 Renders prototyped_node.
 
virtual void traverseSG (TraverseInfo &ti)
 Traverses prototyped_node.
 
virtual void setPrototypedNode (Node *n)
 Set the node that is the internal scenegraph of the prototype.
 
virtual NodegetPrototypedNode ()
 Get the node that is the internal scenegraph of the prototype.
 
virtual void addPrototypedNodeExtra (Node *n)
 Set the node that is the internal scenegraph of the prototype.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value.
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual bool connectField (const string &proto_field_name, Field *f)
 Connect the field from the prototype node named proto_field_name with the specified field. More...
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (const string &_name)
 Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...
 
- Public Member Functions inherited from H3D::Node
 Node ()
 Constructor.
 
virtual ~Node ()
 Destructor.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...
 
void setProtoInstanceParent (X3DPrototypeInstance *p)
 Set the X3DPrototypeInstance this node is the the root node if applicaple.
 
virtual FieldgetField (const string &_name) const
 return a pointer to the field specified by name within this instance
 
int addDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
int removeDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
- Public Member Functions inherited from H3D::H3DDynamicFieldsObject
virtual bool addField (const string &name, const Field::AccessType &access, Field *field)
 Add a field to the Node. More...
 
virtual bool removeField (const string &_name)
 Remove a field from the Node. More...
 
field_iterator firstField ()
 Get an iterator to the first of the dynamic fields.
 
field_iterator endField ()
 Get an iterator pointing to the end of the dynamic fields.
 
virtual void clearFields ()
 Remove all dynamic fields that have been previously added.
 
 H3DDynamicFieldsObject ()
 Constructor.
 
- Public Member Functions inherited from H3D::H3DBoundedObject
 H3DBoundedObject (Inst< SFBound > _bound=0)
 Constructor.
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DPrototypeInstance
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Additional Inherited Members

- Public Types inherited from H3D::Node
typedef std::map< Node *, Node * > DeepCopyMap
 A map type used during a deep copy clone() to map from original nodes to cloned nodes.
 
- Static Public Member Functions inherited from H3D::Node
static unsigned int nrNodesAlive ()
 Returns the nr of nodes currently alive, i.e. nodes created but not destructed.
 
static int nrNodesCreated ()
 Returns the number of nodes created in total since the start of the program.
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::H3DBoundedObject
H3DUniquePtr< SFBoundbound
 The field containing the bound object. More...
 
- Protected Member Functions inherited from H3D::Node
void cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for the clone() method. More...
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

The PrototypeInstance is an instance of a prototyped node.

Examples:

Member Function Documentation

◆ clone()

Node * PrototypeInstance::clone ( bool  deepCopy = true,
DeepCopyMap deepCopyMap = NULL 
)
virtual

Returns a new instance of this node type with the same state as this one.

The default implementation copies the node's registered field values of access type INPUT_OUTPUT and INITIALIZE_ONLY.

Parameters
deepCopyIf true then references to other nodes will also be cloned. Otherwise just the pointer is copied.
deepCopyMapA map from original nodes to their cloned versions. This parameter is normally not required by the root caller, but is passed down the call graph to ensure that nodes that appear multiple times will be assigned the same clone.

Reimplemented from H3D::Node.

References H3DUtil::AutoRefVector< class >::begin(), H3DUtil::AutoRefVector< class >::end(), H3D::Node::getClonedInstance(), H3D::X3DNode::metadata, PrototypeInstance(), H3DUtil::AutoRefVector< class >::push_back(), H3DUtil::AutoRefVector< class >::reserve(), and H3DUtil::AutoRefVector< class >::size().


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