This abstract node type is the base type for all prototype instances in the X3D system. More...

#include <H3D/X3DPrototypeInstance.h>

Inheritance diagram for H3D::X3DPrototypeInstance:

Public Member Functions
	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 Node *	getPrototypedNode ()
	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.

X3DMetadataObject *	getMetadataByName (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 *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	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 Field *	getField (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::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< SFNode >	metadata
	Meta data about the node. More...

Public Attributes inherited from H3D::H3DBoundedObject
H3DUniquePtr< SFBound >	bound
	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 Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

Detailed Description

This abstract node type is the base type for all prototype instances in the X3D system.

Any user-defined nodes declared with PROTO or EXTERNPROTO are instantiated using this base type. An X3DPrototypeInstance may be place anywhere in the scene graph where it is legal to place the first node declared within the prototype instance. For example, if the base type of first node is X3DAppearanceNode, that prototype may be instantiated anywhere in the scene graph that allows for an appearance node system.

Member Function Documentation

◆ closestPoint()

virtual void H3D::X3DPrototypeInstance::closestPoint	(	const Vec3f &	p,
		NodeIntersectResult &	result
	)

inlinevirtual

Find closest point on Node to p.

Parameters

p	The point to find the closest point to.
result	A struct containing various results of closest points such as which geometries the closest points where detected on.

Reimplemented from H3D::Node.

◆ connectField()

bool X3DPrototypeInstance::connectField	(	const string &	proto_field_name,
		Field *	f
	)

virtual

Connect the field from the prototype node named proto_field_name with the specified field.

Returns true on success.

References H3D::Field::getAccessType(), H3D::Node::getField(), H3D::Field::INITIALIZE_ONLY, H3D::Field::INPUT_OUTPUT, H3D::Field::isAccessCheckOn(), H3D::Field::OUTPUT_ONLY, H3D::Field::route(), H3D::Field::routeNoEvent(), and H3D::Field::setAccessCheck().

◆ lineIntersect()

virtual bool H3D::X3DPrototypeInstance::lineIntersect	(	const Vec3f &	from,
		const Vec3f &	to,
		LineIntersectResult &	result
	)

inlinevirtual

Detect intersection between a line segment and the Node.

Parameters

from	The start of the line segment.
to	The end of the line segment.
result	Contains info about the closest intersection for every object that intersects the line.

Returns: true if intersected, false otherwise.

Reimplemented from H3D::Node.

◆ movingSphereIntersect()

virtual bool H3D::X3DPrototypeInstance::movingSphereIntersect	(	H3DFloat	radius,
		const Vec3f &	from,
		const Vec3f &	to,
		NodeIntersectResult &	result
	)

inlinevirtual

Detect collision between a moving sphere and the Node.

Only nodes to which collision is possible will return true

Parameters

radius	The radius of the sphere
from	The start position of the sphere
to	The end position of the sphere.
result	A struct containing various results of intersections such as which geometries intersected the moving sphere.

Returns: true if intersected, false otherwise.

Reimplemented from H3D::Node.

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ closestPoint()

◆ connectField()

◆ lineIntersect()

◆ movingSphereIntersect()