H3D::ProtoDeclaration Class Reference

The ProtoDeclaration class containse information about a PROTO node from the X3D standard. More...

#include <ProtoDeclaration.h>

List of all members.

Public Member Functions

 ProtoDeclaration (const string &_name, const string &_body="")
 Constructor.
const string & getProtoBody ()
 Get the string with the internal scenegraph of the prototype.
void setProtoBody (const string &_body)
 Set the string with the internal scenegraph of the prototype.
const string & getName ()
 Get the name of the prototype.
void setName (const string &_name)
 Get the name of the prototype.
void addFieldDeclaration (const string &name, const X3DTypes::X3DType &type, const Field::AccessType &access_type, const string &value="")
 Add a field to the prototype.
FieldDeclarationgetFieldDeclaration (const string &name)
 Get the field declaration of the given name.
X3DPrototypeInstancenewProtoInstance ()
 Create a new X3DPrototypeInstance instance using the ProtoDeclaration.

Protected Attributes

string name
string body
std::list< FieldDeclarationfield_declarations

Classes

class  FieldDeclaration
 Class that contains information about a field that is part of the prototype declaration. More...


Detailed Description

The ProtoDeclaration class containse information about a PROTO node from the X3D standard.

It contains everything that is needed to now about the prototype and allows you to create new instances of the prototype with the newProtoInstance function.


Constructor & Destructor Documentation

H3D::ProtoDeclaration::ProtoDeclaration const string &  _name,
const string &  _body = ""
[inline]
 

Constructor.

Parameters:
The name of the prototype.
String with the internal scenegraph of the prototype.


Member Function Documentation

FieldDeclaration* H3D::ProtoDeclaration::getFieldDeclaration const string &  name  )  [inline]
 

Get the field declaration of the given name.

Returns true if such a field declaration exists, false otherwise


Generated on Thu Aug 24 12:39:49 2006 for H3D API by  doxygen 1.4.5