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

This abstract interface is the basis for all metadata nodes. More...

#include <H3D/X3DMetadataObject.h>

Inheritance diagram for H3D::X3DMetadataObject:
Inheritance graph

Public Member Functions

 X3DMetadataObject (Inst< SFString > _name=0, Inst< SFString > _reference=0)
 Constructor.
 
virtual ~X3DMetadataObject ()
 Force polymorphic E.g., to allow dynamic_cast to concrete metadata types.
 
virtual X3DMetadataObjectgetMetadataByName (const string &name)
 Given a name, the first X3DMetadataObject that matches that name is returned. More...
 

Public Attributes

H3DUniquePtr< SFStringnameF
 Metadata name. More...
 
H3DUniquePtr< SFStringreference
 The specification of the reference field is optional. More...
 

Detailed Description

This abstract interface is the basis for all metadata nodes.

The interface is inherited by all metadata nodes. The specification of the reference field is optional. If provided, it identifies the metadata standard or other specification that defines the name field. If the reference field is not provided or is empty, the meaning of the name field is considered implicit to the characters in the string.

Member Function Documentation

◆ getMetadataByName()

X3DMetadataObject * X3DMetadataObject::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 in H3D::MetadataSet.

References nameF.

Referenced by H3D::X3DNode::getMetadataByName().

Member Data Documentation

◆ nameF

H3DUniquePtr< SFString > H3D::X3DMetadataObject::nameF

Metadata name.

Access type: inputOutput

Referenced by H3D::MetadataSet::getMetadataByName(), and getMetadataByName().

◆ reference

H3DUniquePtr< SFString > H3D::X3DMetadataObject::reference

The specification of the reference field is optional.

If provided, it identifies the metadata standard or other specification that defines the name field.

Access type: inputOutput


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