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

The metadata provided by this node is contained in the metadata nodes of the value field. More...

#include <H3D/MetadataSet.h>

Inheritance diagram for H3D::MetadataSet:
Inheritance graph

Public Member Functions

 MetadataSet (Inst< SFString > _name=0, Inst< SFString > _reference=0, Inst< SFMetadataNode > _metadata=0, Inst< MFMetadataNode > _value=0)
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual X3DMetadataObjectgetMetadataByName (const string &_name)
 Given a name, the first X3DMetadataObject that matches that name is returned. 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 Nodeclone (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.
 
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 void render ()
 the render() function is used for the depth-first rendering traversal of the scene-graph. More...
 
virtual void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
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 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::X3DMetadataObject
 X3DMetadataObject (Inst< SFString > _name=0, Inst< SFString > _reference=0)
 Constructor.
 
virtual ~X3DMetadataObject ()
 Force polymorphic E.g., to allow dynamic_cast to concrete metadata types.
 

Public Attributes

H3DUniquePtr< SFMetadataNodemetadata
 X3DMetadataObject with more meta data. More...
 
H3DUniquePtr< MFMetadataNodevalue
 The metadata X3DMetadataObjects. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::X3DMetadataObject
H3DUniquePtr< SFStringnameF
 Metadata name. More...
 
H3DUniquePtr< SFStringreference
 The specification of the reference field is optional. More...
 

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.
 
- 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 metadata provided by this node is contained in the metadata nodes of the value field.

Examples:

Member Function Documentation

◆ defaultXMLContainerField()

virtual string H3D::MetadataSet::defaultXMLContainerField ( )
inlinevirtual

Returns the default xml containerField attribute value.

For this node it is "metadata".

Reimplemented from H3D::Node.

◆ getMetadataByName()

X3DMetadataObject * MetadataSet::getMetadataByName ( const string &  _name)
virtual

Given a name, the first X3DMetadataObject that matches that name is returned.

If no such X3DMetadataObject exists, NULL is returned.

Parameters
_nameThe name of the X3DMetadataObject to get.
Returns
The first X3DMetadataObject in the metadata field that matches that name if it exists, NULL otherwise

Reimplemented from H3D::X3DMetadataObject.

References H3DUtil::RefCountedClass::name, H3D::X3DMetadataObject::nameF, and value.

Member Data Documentation

◆ metadata

H3DUniquePtr< SFMetadataNode > H3D::MetadataSet::metadata

X3DMetadataObject with more meta data.

Access type: inputOutput

◆ value

H3DUniquePtr< MFMetadataNode > H3D::MetadataSet::value

The metadata X3DMetadataObjects.

Access type: inputOutput

Referenced by getMetadataByName().


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