agxTerrain::Shovel::ExcavationSettings Class Reference

Class containing the settings for the different ExcavationModes for a shovel. More...

#include <Shovel.h>

Public Member Functions
	ExcavationSettings ()
	Default constructor.
	ExcavationSettings (agx::UInt32 state)
	Constructor taking an internal state variable from another excavation setting object.
bool	getEnable () const
bool	getEnableCreateDynamicMass () const
bool	getEnableForceFeedback () const
agx::UInt32	getState () const
void	restore (agxStream::InputArchive &in)
void	setEnable (bool enable)
	Set whether the excavation mode should be enabled, creating dynamic mass and generating force feedback.
void	setEnableCreateDynamicMass (bool enable)
	Set true/false if the excavation mode should create dynamic mass.
void	setEnableForceFeedback (bool enable)
	Set true/false if the excavation mode should generate force feedback from created aggregates.
void	store (agxStream::OutputArchive &out) const

Detailed Description

Class containing the settings for the different ExcavationModes for a shovel.

Definition at line 489 of file Shovel.h.

Constructor & Destructor Documentation

ExcavationSettings() [1/2]

agxTerrain::Shovel::ExcavationSettings::ExcavationSettings

(

)

Default constructor.

ExcavationSettings() [2/2]

agxTerrain::Shovel::ExcavationSettings::ExcavationSettings

(

agx::UInt32

state

)

Constructor taking an internal state variable from another excavation setting object.

Parameters

state

- The internal state data from another excavation setting object.

Member Function Documentation

getEnable()

bool agxTerrain::Shovel::ExcavationSettings::getEnable

(

)

const

Returns

whether the excavation mode should be enabled, creating dynamic mass and generating force feedback.

getEnableCreateDynamicMass()

bool agxTerrain::Shovel::ExcavationSettings::getEnableCreateDynamicMass

(

)

const

Returns

whether the excavation mode should create dynamic mass.

getEnableForceFeedback()

bool agxTerrain::Shovel::ExcavationSettings::getEnableForceFeedback

(

)

const

Returns

whether the excavation mode should generate force feedback from created aggregates.

getState()

agx::UInt32 agxTerrain::Shovel::ExcavationSettings::getState

(

)

const

Returns

the internal state variable for the shovel settings.

restore()

void agxTerrain::Shovel::ExcavationSettings::restore ( agxStream::InputArchive &  in )

inline

Definition at line 542 of file Shovel.h.

setEnable()

void agxTerrain::Shovel::ExcavationSettings::setEnable

(

bool

enable

)

Set whether the excavation mode should be enabled, creating dynamic mass and generating force feedback.

Parameters

enable

- true/false if the excavation mode should generate force feedback and create dynamic mass.s

setEnableCreateDynamicMass()

void agxTerrain::Shovel::ExcavationSettings::setEnableCreateDynamicMass

(

bool

enable

)

Set true/false if the excavation mode should create dynamic mass.

Parameters

enable

- true if the excavation mode should create dynamic mass.

setEnableForceFeedback()

void agxTerrain::Shovel::ExcavationSettings::setEnableForceFeedback

(

bool

enable

)

Set true/false if the excavation mode should generate force feedback from created aggregates.

Parameters

enable

- true if the excavation mode should generate force feedback from created aggregates.

store()

void agxTerrain::Shovel::ExcavationSettings::store ( agxStream::OutputArchive &  out ) const

inline

Definition at line 541 of file Shovel.h.

---

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

• Shovel.h