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

Specifies parameters for if displaying debug information like bounding boxes, haptically rendered triangles etc. More...

#include <H3D/DebugOptions.h>

Inheritance diagram for H3D::DebugOptions:
Inheritance graph

Public Member Functions

 DebugOptions (Inst< SFNode > _metadata=0, Inst< SFBool > _drawBound=0, Inst< SFInt32 > _drawBoundTree=0, Inst< SFBool > _drawHapticTriangles=0, Inst< SFBool > _printShaderWarnings=0)
 Constructor.
 
- Public Member Functions inherited from H3D::H3DOptionNode
 H3DOptionNode (Inst< SFNode > _metadata=0)
 Constructor.
 
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< SFBooldrawBound
 If true the outline of the bounding box in the bound field of X3DGeometryNodes will be rendered. More...
 
H3DUniquePtr< SFInt32drawBoundTree
 If -1, nothing will be drawn. More...
 
H3DUniquePtr< SFBooldrawHapticTriangles
 If true the outline of the triangles currently being sent to be rendered by the haptics renderer is drawn. More...
 
H3DUniquePtr< SFBoolprintShaderWarnings
 If true then shaders will print its log to Console even if there are no errors. More...
 
- Public Attributes inherited from H3D::H3DOptionNode
H3DUniquePtr< FieldupdateOption
 Field to collect update event from every option parameters, all inherited Option Node should route its option parameter fields to it.
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. 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.
 
- 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.
 
- 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

Specifies parameters for if displaying debug information like bounding boxes, haptically rendered triangles etc.

Examples:

Member Data Documentation

◆ drawBound

H3DUniquePtr< SFBool > H3D::DebugOptions::drawBound

If true the outline of the bounding box in the bound field of X3DGeometryNodes will be rendered.

Default value: false
Access type: inputOutput

Referenced by DebugOptions().

◆ drawBoundTree

H3DUniquePtr< SFInt32 > H3D::DebugOptions::drawBoundTree

If -1, nothing will be drawn.

If >= 0 the bounding boxes at that depth in the bound are drawn.

Default value: -1
Access type: inputOutput

Referenced by DebugOptions().

◆ drawHapticTriangles

H3DUniquePtr< SFBool > H3D::DebugOptions::drawHapticTriangles

If true the outline of the triangles currently being sent to be rendered by the haptics renderer is drawn.

Default value: false
Access type: inputOutput

Referenced by DebugOptions().

◆ printShaderWarnings

H3DUniquePtr< SFBool > H3D::DebugOptions::printShaderWarnings

If true then shaders will print its log to Console even if there are no errors.

Default value: false
Access type: inputOutput

Referenced by DebugOptions().


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