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

The function node implements a gaussian function. More...

#include <H3D/GaussianFunction.h>

Inheritance diagram for H3D::GaussianFunction:
Inheritance graph

Public Member Functions

 GaussianFunction (Inst< SFNode > _metadata=0, Inst< SFFloat > _center=0, Inst< SFFloat > _amplitude=0, Inst< SFFloat > _width=0)
 Constructor.

 
virtual H3DDouble evaluate (H3DDouble *_input)
 Evaluate the function for the given input.
 
virtual unsigned int nrInputValues ()
 Returns the number of input values the function takes.
 
virtual HAPI::HAPIFunctionObject * getAsHAPIFunctionObject ()
 Returns the function as a HAPIFunctionObject. More...
 
- Public Member Functions inherited from H3D::H3DFunctionNode
 H3DFunctionNode (Inst< SFNode > _metadata=0, Inst< MFDouble > _input=0, Inst< Value > _output=0)
 Constructor.
 
H3DDouble evaluate (H3DDouble _input)
 Shortcut for functions just taking one input.
 
H3DDouble get (H3DDouble _input)
 Same as evaluate(). For backwards compatability.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. 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 Attributes

H3DUniquePtr< SFFloatcenter
 The value for the center of the gaussian. More...
 
H3DUniquePtr< SFFloatamplitude
 The amplitude of the gaussian. More...
 
H3DUniquePtr< SFFloatwidth
 The width of the gaussian. More...
 
- Public Attributes inherited from H3D::H3DFunctionNode
H3DUniquePtr< MFDoubleinput
 Input value to the function to evaluate.
 
H3DUniquePtr< Valueoutput
 Output value from the function when evaluated for the input values given in the input field.
 
H3DUniquePtr< FieldfunctionChanged
 Field that indicated whether the function has changed. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 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 NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

The function node implements a gaussian function.

Examples:

Member Function Documentation

◆ getAsHAPIFunctionObject()

HAPI::HAPIFunctionObject * GaussianFunction::getAsHAPIFunctionObject ( )
virtual

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 from H3D::H3DFunctionNode.

References amplitude, center, and width.

Member Data Documentation

◆ amplitude

H3DUniquePtr< SFFloat > H3D::GaussianFunction::amplitude

The amplitude of the gaussian.

Access type: inputOutput
Default value: 1

Referenced by evaluate(), GaussianFunction(), and getAsHAPIFunctionObject().

◆ center

H3DUniquePtr< SFFloat > H3D::GaussianFunction::center

The value for the center of the gaussian.

Access type: inputOutput
Default value: 0

Referenced by evaluate(), GaussianFunction(), and getAsHAPIFunctionObject().

◆ width

H3DUniquePtr< SFFloat > H3D::GaussianFunction::width

The width of the gaussian.

Access type: inputOutput
Default value: 1

Referenced by evaluate(), GaussianFunction(), and getAsHAPIFunctionObject().


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