Base class for nodes evaluating function. More...
#include <H3D/H3DFunctionNode.h>
Inheritance diagram for H3D::H3DFunctionNode:
Classes | |
| class | Value |
| Field class that calculates the function value for the given input. More... | |
Public Member Functions | |
| H3DFunctionNode (Inst< SFNode > _metadata=0, Inst< MFDouble > _input=0, Inst< Value > _output=0) | |
| Constructor. | |
| virtual H3DDouble | evaluate (H3DDouble *input)=0 |
| Evaluate the function for the given input. | |
| H3DDouble | evaluate (H3DDouble _input) |
| Shortcut for functions just taking one input. | |
| H3DDouble | get (H3DDouble _input) |
| Same as evaluate(). For backwards compatability. | |
| virtual unsigned int | nrInputValues ()=0 |
| Returns the number of input values the function takes. | |
| virtual HAPI::HAPIFunctionObject * | getAsHAPIFunctionObject () |
| Returns the function as a HAPIFunctionObject. More... | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. 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 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 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 Attributes | |
| H3DUniquePtr< MFDouble > | input |
| Input value to the function to evaluate. | |
| H3DUniquePtr< Value > | output |
| Output value from the function when evaluated for the input values given in the input field. | |
| H3DUniquePtr< Field > | functionChanged |
| Field that indicated whether the function has changed. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
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. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| 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
Base class for nodes evaluating function.
The function is a function R^n -> R.
Member Function Documentation
◆ defaultXMLContainerField()
|
inlinevirtual |
Returns the default xml containerField attribute value.
For this node it is "children".
Reimplemented from H3D::Node.
◆ getAsHAPIFunctionObject()
|
inlinevirtual |
Returns the function as a HAPIFunctionObject.
Should return a new copy if the H3DFunctionNode stores a copy of HAPIFunctionObject since owner ship of the returned HAPIFunctionObject should be considered to belong to the caller of the function. Returns NULL if the H3DFunctionNode can not be represented as a HAPIFunctionObject.
Reimplemented in H3D::GeneralFunction, and H3D::GaussianFunction.
Referenced by H3D::PositionFunctionEffect::traverseSG(), and H3D::TimeFunctionEffect::traverseSG().
Member Data Documentation
◆ functionChanged
| H3DUniquePtr< Field > H3D::H3DFunctionNode::functionChanged |
Field that indicated whether the function has changed.
Since H3DFunctionNode is an abstract type we do not know anything about which fields will be available. Subclasses must route in all fields that determines if the properties have changed.
Referenced by H3D::GaussianFunction::GaussianFunction(), H3D::GeneralFunction::GeneralFunction(), and H3DFunctionNode().
The documentation for this class was generated from the following files:
