Murl::Graph::IContact Interface Reference

The IContact graph node interface. More...

#include "murl_graph_i_contact.h"

Inheritance diagram for Murl::Graph::IContact:

Public Member Functions
virtual INode *	GetNodeInterface ()=0
	Get the mutable Graph::INode interface. More...
virtual const INode *	GetNodeInterface () const =0
	Get the constant Graph::INode interface. More...
virtual ISurfaceNodeTarget *	GetSurfaceNodeTarget ()=0
	Get the mutable Graph::ISurfaceNodeTarget container. More...
virtual const ISurfaceNodeTarget *	GetSurfaceNodeTarget () const =0
	Get the constant Graph::ISurfaceNodeTarget container. More...
virtual Bool	SetStaticFrictionConstant (Real value)=0
	Set the contact's static friction coefficient. More...
virtual Real	GetStaticFrictionConstant () const =0
	Get the contact's static friction coefficient. More...
virtual Bool	SetDynamicFrictionConstant (Real value)=0
	Set the contact's dynamic (kinetic) friction coefficient. More...
virtual Real	GetDynamicFrictionConstant () const =0
	Get the contact's dynamic friction coefficient. More...
virtual Bool	SetRollingFrictionConstant (Real value)=0
	Set the contact's rolling friction coefficient. More...
virtual Real	GetRollingFrictionConstant () const =0
	Get the contact's rolling friction coefficient. More...
virtual Bool	SetSpringConstant (Real value)=0
	Set the contact's spring constant. More...
virtual Real	GetSpringConstant () const =0
	Get the contact's spring constant. More...
virtual Bool	SetDampingConstant (Real value)=0
	Set the contact's damping constant. More...
virtual Real	GetDampingConstant () const =0
	Get the contact's damping constant. More...
virtual Bool	SetBounceFactor (Real value)=0
	Set the contact's bounce factor. More...
virtual Real	GetBounceFactor () const =0
	Get the contact's bounce factor. More...
virtual Bool	SetBounceThreshold (Real value)=0
	Set the contact's bounce velocity threshold. More...
virtual Real	GetBounceThreshold () const =0
	Get the contact's bounce velocity threshold. More...
virtual Bool	SetSlip (Real slip)=0
	Set the contact's surface slip value. More...
virtual Real	GetSlip () const =0
	Get the contact's surface slip value. More...

Detailed Description

The IContact graph node interface.

Contact nodes define the actual physical properties of a possible collision in the physics simulator, such as bounciness or friction. Every possible (or desired) combination of Graph::ISurface pairs must be defined via a contact.

See Graph::ISurface for defining a collision surface. See Graph::ISurfaceSlot for activating a surface for collision handling. See Graph::ICollidable for assigning a surface to a given collider.

Member Function Documentation

GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IContact::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::IContact::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

GetSurfaceNodeTarget() [1/2]

virtual ISurfaceNodeTarget* Murl::Graph::IContact::GetSurfaceNodeTarget ( )

pure virtual

Get the mutable Graph::ISurfaceNodeTarget container.

This method returns a mutable pointer to the node's Graph::ISurfaceNodeTarget container, which allows to set or query the surface this state node refers to.

Returns

The mutable Graph::ISurfaceNodeTarget container, or null if not available.

GetSurfaceNodeTarget() [2/2]

virtual const ISurfaceNodeTarget* Murl::Graph::IContact::GetSurfaceNodeTarget ( ) const

pure virtual

Get the constant Graph::ISurfaceNodeTarget container.

This method returns a constant pointer to the node's Graph::ISurfaceNodeTarget container, which allows to query the surface this state node refers to.

Returns

The mutable Graph::ISurfaceNodeTarget container, or null if not available.

SetStaticFrictionConstant()

virtual Bool Murl::Graph::IContact::SetStaticFrictionConstant ( Real  value )

pure virtual

Set the contact's static friction coefficient.

Parameters

value

The static friction coefficient.

Returns

true if successful.

GetStaticFrictionConstant()

virtual Real Murl::Graph::IContact::GetStaticFrictionConstant ( ) const

pure virtual

Get the contact's static friction coefficient.

Returns

The contact's static friction coefficient.

SetDynamicFrictionConstant()

virtual Bool Murl::Graph::IContact::SetDynamicFrictionConstant ( Real  value )

pure virtual

Set the contact's dynamic (kinetic) friction coefficient.

Parameters

value

The contact's dynamic friction coefficient.

Returns

true if successful.

GetDynamicFrictionConstant()

virtual Real Murl::Graph::IContact::GetDynamicFrictionConstant ( ) const

pure virtual

Get the contact's dynamic friction coefficient.

Returns

The contact's dynamic friction coefficient.

SetRollingFrictionConstant()

virtual Bool Murl::Graph::IContact::SetRollingFrictionConstant ( Real  value )

pure virtual

Set the contact's rolling friction coefficient.

TODO: More detailed description.

Parameters

value

The contact's rolling friction coefficient.

Returns

true if successful.

GetRollingFrictionConstant()

virtual Real Murl::Graph::IContact::GetRollingFrictionConstant ( ) const

pure virtual

Get the contact's rolling friction coefficient.

Returns

The contact's rolling friction coefficient.

SetSpringConstant()

virtual Bool Murl::Graph::IContact::SetSpringConstant ( Real  value )

pure virtual

Set the contact's spring constant.

TODO: More detailed description.

Parameters

value

The contact's spring constant.

Returns

true if successful.

GetSpringConstant()

virtual Real Murl::Graph::IContact::GetSpringConstant ( ) const

pure virtual

Get the contact's spring constant.

Returns

The contact's spring constant.

SetDampingConstant()

virtual Bool Murl::Graph::IContact::SetDampingConstant ( Real  value )

pure virtual

Set the contact's damping constant.

TODO: More detailed description.

Parameters

value

The contact's damping constant.

Returns

true if successful.

GetDampingConstant()

virtual Real Murl::Graph::IContact::GetDampingConstant ( ) const

pure virtual

Get the contact's damping constant.

Returns

The contact's damping constant.

SetBounceFactor()

virtual Bool Murl::Graph::IContact::SetBounceFactor ( Real  value )

pure virtual

Set the contact's bounce factor.

TODO: More detailed description.

Parameters

value

The contact's bounce factor.

Returns

true if successful.

GetBounceFactor()

virtual Real Murl::Graph::IContact::GetBounceFactor ( ) const

pure virtual

Get the contact's bounce factor.

Returns

The contact's bounce factor.

SetBounceThreshold()

virtual Bool Murl::Graph::IContact::SetBounceThreshold ( Real  value )

pure virtual

Set the contact's bounce velocity threshold.

TODO: More detailed description.

Parameters

value

The contact's bounce velocity threshold.

Returns

true if successful.

GetBounceThreshold()

virtual Real Murl::Graph::IContact::GetBounceThreshold ( ) const

pure virtual

Get the contact's bounce velocity threshold.

Returns

The contact's bounce velocity threshold.

SetSlip()

virtual Bool Murl::Graph::IContact::SetSlip ( Real  slip )

pure virtual

Set the contact's surface slip value.

TODO: More detailed description.

Parameters

slip	The contact's surface slip value.

Returns

true if successful.

GetSlip()

virtual Real Murl::Graph::IContact::GetSlip ( ) const

pure virtual

Get the contact's surface slip value.

Returns

The contact's surface slip value.

---

The documentation for this interface was generated from the following file:

• murl_graph_i_contact.h