Murl::Graph::IHingeJoint Interface Referenceabstract

The IHingeJoint graph node interface. More...

`#include "murl_graph_i_hinge_joint.h"`

Inheritance diagram for Murl::Graph::IHingeJoint:

## Public Member Functions

virtual INodeGetNodeInterface ()=0
Get the mutable Graph::INode interface. More...

virtual const INodeGetNodeInterface () const =0
Get the constant Graph::INode interface. More...

virtual ITransformGetTransformInterface ()=0
Get the mutable Graph::ITransform interface. More...

virtual const ITransformGetTransformInterface () const =0
Get the constant Graph::ITransform interface. More...

virtual IJointGetJointInterface ()=0
Get the mutable Graph::IJoint interface. More...

virtual const IJointGetJointInterface () const =0
Get the constant Graph::IJoint interface. More...

virtual Bool SetAxis (const Vector &axis)=0
Set the hinge joint's rotation axis. More...

virtual const VectorGetAxis () const =0
Get the hinge joint's rotation axis. More...

virtual Bool SetMinAngle (Real angle)=0
Set the hinge joint's minimum angle limit. More...

virtual Real GetMinAngle () const =0
Get the hinge joint's minimum angle limit. More...

virtual Bool SetMaxAngle (Real angle)=0
Set the hinge joint's maximum angle limit. More...

virtual Real GetMaxAngle () const =0
Get the hinge joint's maximum angle limit. More...

## Detailed Description

The IHingeJoint graph node interface.

A hinge joint is a joint that connects two bodies by enforcing a translation constraint along each of the three axes in 3D space, as well as rotation constraints that allow rotation around a single axis only (1 degree of freedom). The rotation axis can be set using the SetAxis() method.

## ◆ GetNodeInterface() [1/2]

 virtual INode* Murl::Graph::IHingeJoint::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

## ◆ GetNodeInterface() [2/2]

 virtual const INode* Murl::Graph::IHingeJoint::GetNodeInterface ( ) const
pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns
The constant Graph::INode interface, or null if not available

## ◆ GetTransformInterface() [1/2]

 virtual ITransform* Murl::Graph::IHingeJoint::GetTransformInterface ( )
pure virtual

Get the mutable Graph::ITransform interface.

This method returns a mutable pointer to the node's Graph::ITransform interface, to be able to query or modify the node's transformation matrix and depth order.

Returns
The mutable Graph::ITransform interface, or null if not available

## ◆ GetTransformInterface() [2/2]

 virtual const ITransform* Murl::Graph::IHingeJoint::GetTransformInterface ( ) const
pure virtual

Get the constant Graph::ITransform interface.

This method returns a constant pointer to the node's Graph::ITransform interface, to be able to query the node's transformation matrix and depth order.

Returns
The constant Graph::ITransform interface, or null if not available

## ◆ GetJointInterface() [1/2]

 virtual IJoint* Murl::Graph::IHingeJoint::GetJointInterface ( )
pure virtual

Get the mutable Graph::IJoint interface.

This method returns a mutable pointer to the node's Graph::IJoint interface, to be able to query or modify common joint-related properties.

Returns
The mutable Graph::IJoint interface.

## ◆ GetJointInterface() [2/2]

 virtual const IJoint* Murl::Graph::IHingeJoint::GetJointInterface ( ) const
pure virtual

Get the constant Graph::IJoint interface.

This method returns a constant pointer to the node's Graph::IJoint interface, to be able to query common joint-related properties.

Returns
The constant Graph::IJoint interface.

## ◆ SetAxis()

 virtual Bool Murl::Graph::IHingeJoint::SetAxis ( const Vector & axis )
pure virtual

Set the hinge joint's rotation axis.

This method sets the axis around which the connected bodies are allowed to rotate relative to each other, relative to the joint's local coordinate system.

Parameters
 axis The rotation axis.
Returns
true if successful.

## ◆ GetAxis()

 virtual const Vector& Murl::Graph::IHingeJoint::GetAxis ( ) const
pure virtual

Get the hinge joint's rotation axis.

Returns
The rotation axis.

## ◆ SetMinAngle()

 virtual Bool Murl::Graph::IHingeJoint::SetMinAngle ( Real angle )
pure virtual

Set the hinge joint's minimum angle limit.

Parameters
 angle The minimum angle.
Returns
true if successful.

## ◆ GetMinAngle()

 virtual Real Murl::Graph::IHingeJoint::GetMinAngle ( ) const
pure virtual

Get the hinge joint's minimum angle limit.

Returns
The minimum angle.

## ◆ SetMaxAngle()

 virtual Bool Murl::Graph::IHingeJoint::SetMaxAngle ( Real angle )
pure virtual

Set the hinge joint's maximum angle limit.

Parameters
 angle The maximum angle.
Returns
true if successful.

## ◆ GetMaxAngle()

 virtual Real Murl::Graph::IHingeJoint::GetMaxAngle ( ) const
pure virtual

Get the hinge joint's maximum angle limit.

Returns
The maximum angle.

The documentation for this interface was generated from the following file:
• murl_graph_i_hinge_joint.h