Candy::ForceTorqueIcon Class Reference

This node generates arrows to visually represent forces and torques. More...

Inheritance diagram for Candy::ForceTorqueIcon:

Classes
struct	Update

Public Attributes
std::auto_ptr< H3D::SFVec3f >	force
	The force to visualize. More...
std::auto_ptr< H3D::SFVec3f >	torque
	The torque to visualize. More...
std::auto_ptr< H3D::SFFloat >	forceScale
	Visual scaling of the incoming force. More...
std::auto_ptr< H3D::SFFloat >	torqueScale
	Visual scaling of the incoming torque. More...
std::auto_ptr< H3D::SFFloat >	torqueRadius
	The radius at which the torque is rendered. More...
std::auto_ptr< H3D::SFFloat >	arrowHeadSize
	The size of arrow heads. More...
Public Attributes inherited from H3D::IndexedLineSet
auto_ptr< MFInt32 >	set_colorIndex
auto_ptr< MFInt32 >	set_coordIndex
auto_ptr< SFColorNode >	color
auto_ptr< SFCoordinateNode >	coord
auto_ptr< MFInt32 >	colorIndex
auto_ptr< SFBool >	colorPerVertex
auto_ptr< MFInt32 >	coordIndex
auto_ptr< SFFogCoordinate >	fogCoord
auto_ptr< MFVertexAttributeNode >	attrib

Static Public Attributes
static H3D::H3DNodeDatabase	database
Static Public Attributes inherited from H3D::IndexedLineSet
static H3DNodeDatabase	database

Protected Member Functions
void	createLines ()

Protected Attributes
std::auto_ptr< Update >	update

Friends
struct	Update

Additional Inherited Members
Public Types inherited from H3D::IndexedLineSet
typedef DependentSFNode < X3DCoordinateNode, FieldRef < X3DGeometricPropertyNode, Field,&X3DCoordinateNode::propertyChanged > >	SFCoordinateNode
typedef DependentSFNode < X3DColorNode, FieldRef < X3DGeometricPropertyNode, Field,&X3DColorNode::propertyChanged > >	SFColorNode
typedef DependentSFNode < FogCoordinate, FieldRef < X3DGeometricPropertyNode, Field,&FogCoordinate::propertyChanged > >	SFFogCoordinate
Public Member Functions inherited from H3D::IndexedLineSet
	IndexedLineSet (Inst< SFNode > _metadata=0, Inst< CoordBoundField > _bound=0, Inst< DisplayList > _displayList=0, Inst< MFInt32 > _set_colorIndex=0, Inst< MFInt32 > _set_coordIndex=0, Inst< SFColorNode > _color=0, Inst< SFCoordinateNode > _coord=0, Inst< MFInt32 > _colorIndex=0, Inst< SFBool > _colorPerVertex=0, Inst< MFInt32 > _coordIndex=0, Inst< SFFogCoordinate > _fogCoord=0, Inst< MFVertexAttributeNode > _attrib=0)
virtual int	nrLines ()
virtual void	render ()
virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)

Detailed Description

This node generates arrows to visually represent forces and torques.

This can be used together with a pen model as the graphical representation of the haptic instrument or as a separate icon. The node provides only lines without colour, so appearance and material properties must be separately specified.

X3D Interface
	Name	Type	Default value	Description
	force	SFVec3f	(0,0,0)	The force to visualize.
	torque	SFVec3f	(0,0,0)	The torque to visualize.
	forceScale	SFFloat	0.1	Visual scaling of the incoming force.
	torqueScale	SFFloat	1.0	Visual scaling of the incoming torque. The incoming torque is transformed from Newtons to radians so an unscaled torque of 6.28 would be rendered as a full revolution.
	torqueRadius	SFFloat	0.02	The radius at which the torque is rendered.
	arrowHeadSize	SFFloat	0.005	The size of arrow heads. Specify zero if no arrow heads should be rendered.

Member Data Documentation

std::auto_ptr< H3D::SFFloat > Candy::ForceTorqueIcon::arrowHeadSize

The size of arrow heads.

Specify zero if no arrow heads should be rendered.

std::auto_ptr< H3D::SFVec3f > Candy::ForceTorqueIcon::force

The force to visualize.

std::auto_ptr< H3D::SFFloat > Candy::ForceTorqueIcon::forceScale

Visual scaling of the incoming force.

The incoming force is scaled from Newtons to meters.

std::auto_ptr< H3D::SFVec3f > Candy::ForceTorqueIcon::torque

The torque to visualize.

std::auto_ptr< H3D::SFFloat > Candy::ForceTorqueIcon::torqueRadius

The radius at which the torque is rendered.

std::auto_ptr< H3D::SFFloat > Candy::ForceTorqueIcon::torqueScale

Visual scaling of the incoming torque.

The incoming torque is transformed from Newton meters to radians so an unscaled torque of 6.28 Nm would be rendered as a full revolution.