The base class for script nodes. More...
#include <H3D/H3DScriptNode.h>
Inheritance diagram for H3D::H3DScriptNode:
Public Member Functions | |
| ~H3DScriptNode () | |
| Destructor. | |
| void | addNamedNodes (X3D::DEFNodes *dn) |
| Add all nodes from the given DEFNodes instance to the scripts set of named nodes. More... | |
| void | addNamedNode (const string &_name, Node *n) |
| Add a named node to the script. More... | |
| int | removeNamedNode (const string &_name) |
| Remove the named node with the provided name. More... | |
| void | clearNamedNodes () |
| Remove all named nodes. | |
| Node * | getNamedNode (const string &_name) |
| Returns the named node with the given name. More... | |
 Public Member Functions inherited from H3D::X3DChildNode | |
| X3DChildNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| 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 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 string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| 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::X3DUrlObject | |
| X3DUrlObject (Inst< MFString > _url=0) | |
| Constructor. | |
| virtual LoadStatus | loadStatus () |
| The loadStatus function returns the status of the loading of the current urls in order to be used with the LoadSensor node. | |
| virtual H3DFloat | loadProgress () |
| The loadProgress() functions returns a value between 0 and 1 indicating how much of the current url has been loaded. More... | |
| void | setURLUsed (const string &_url_used) |
| Set the url that is currently loaded. | |
| const string & | getURLUsed () |
| Get the url that is currently loaded. | |
| void | setURLBase (const string &_url_base) |
| Set the url base address. | |
| const string & | getURLBase () |
| Get the current url base address. | |
| string | resolveURLAsFile (const string &url, bool *is_tmp_file=NULL) |
| Get the url as a local file. | |
| string | resolveURLAsString (const string &url) |
| Get the content of the URL as a string. | |
| bool | removeTmpFile (const string &file) |
| Remove a tmpfile with the given name. 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. | |
| Public Types inherited from H3D::X3DUrlObject | |
| enum | LoadStatus { INIT , LOADED , LOADING , FAILED } |
| The load status of the given url. More... | |
| 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::X3DUrlObject | |
| H3DUniquePtr< MFString > | url |
| The urls in decreasing order of preference. | |
| 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... | |
| Protected Member Functions inherited from H3D::X3DUrlObject | |
| string | resolveURL (const string &_url, bool return_contents, bool *is_tmp_file=NULL) |
| Helper function for resolveURLAs*() functions. | |
| void | addInlinePrefix (const string &s) |
| Add a inline prefix that this node supports. | |
| int | getInlinedContentOffset (const std::string &url) |
| If the URL contains any inline prefix, return the index of the start of the inlined content. 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... | |
| Protected Attributes inherited from H3D::X3DUrlObject | |
| string | url_used |
| If loadStatus() returns LOADED this string should contain the url that is loaded. More... | |
| string | url_base |
| The base URL for urls in this url object. More... | |
| list< string > | supported_inline_prefixes |
| A list of inline prefixes that are supported by this url object. More... | |
Detailed Description
The base class for script nodes.
Member Function Documentation
◆ addNamedNode()
| void H3DScriptNode::addNamedNode | ( | const string & | _name, |
| Node * | n | ||
| ) |
Add a named node to the script.
If a node with the same name already exists it will be overwritten.
References H3D::Node::addDestructCallback().
Referenced by addNamedNodes().
◆ addNamedNodes()
| void H3DScriptNode::addNamedNodes | ( | X3D::DEFNodes * | dn | ) |
Add all nodes from the given DEFNodes instance to the scripts set of named nodes.
If nodes with the same name already exists they will be overwritten.
References addNamedNode(), H3D::X3D::DEFNodes::begin(), and H3D::X3D::DEFNodes::end().
◆ getNamedNode()
| Node * H3DScriptNode::getNamedNode | ( | const string & | _name | ) |
Returns the named node with the given name.
NULL if no such node exists.
◆ removeNamedNode()
| int H3DScriptNode::removeNamedNode | ( | const string & | _name | ) |
Remove the named node with the provided name.
- Returns
- 0 on success, -1 if node with that name does not exist.
The documentation for this struct was generated from the following files:
