agxTerrain::deprecated::TerrainToolCollection Class Reference

Collection of terrain tool (currently Shovel) related objects which are terrain instance specific. More...

#include <TerrainToolCollection.h>

Inheritance diagram for agxTerrain::deprecated::TerrainToolCollection:

Public Member Functions
	TerrainToolCollection (Terrain *terrain, Shovel *shovel)
void	clearActiveZoneWedges () const
PrimaryActiveZone *	getActiveZone () const
AggregateContactGenerator *	getAggregateContactGenerator () const
agx::Real	getAggregateTerrainContactDepth (Shovel::ExcavationMode excavationMode) const
DeformController *	getDeformController () const
agx::Frame *	getParentFrame () const
SoilPenetrationResistance *	getPenetrationResistance () const
Shovel *	getShovel () const
SoilParticleAggregate *	getSoilParticleAggregate () const
Terrain *	getTerrain () const
bool	getUseCustomFricionModel () const
const agxCollide::GeometryRefVector &	getVoxelCollisionGeometries () const
const agx::RigidBody *	getWedgeAggregate (Shovel::ExcavationMode excavationMode) const
agx::Bool	initialized () const
void	recomputeInnerShape ()
void	setEnableShovelTerrainGeometryContacts (bool enable)
void	setUseCustomFrictionModel (bool enable)
void	setZeroAggregateVelocity (bool enable)
agx::Bool	shouldUpdate ()
bool	shovelEnableHasChanged () const
Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.
	Referenced (const Referenced &)
template<typename T >
T *	as ()
	Subclass casting.
template<typename T >
const T *	as () const
template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.
template<typename T >
const T *	asSafe () const
int	getReferenceCount () const
template<typename T >
bool	is () const
	Subclass test.
Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.
void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
Public Member Functions inherited from agxStream::Serializable
virtual	~Serializable ()
	Destructor for normal C++ use but hidden from SWIG bindings.
virtual const char *	getClassName () const
bool	getEnableSerialization () const
bool	getEnableUuidGeneration ()
agx::UInt32	getIndex () const
	This index is given at creation of this object.
virtual StorageAgent *	getStorageAgent () const =0
agx::Uuid	getUuid () const
bool	isFinished () const
void	setEnableSerialization (bool flag)
	Set to false to disable serialization of this object.
void	setFinished ()
	Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
void	setUuid (const agx::Uuid &uuid)
	Explicitly set a Uuid on a serializable object.

Protected Types
using	Flags = agx::BitState< StateFlags, agx::UInt32 >
enum	StateFlags : agx::UInt32 { ENABLED = 1 << 0 , SHOVEL_ENABLED = 1 << 1 , SET_ZERO_AGGREGATE_VELOCITY = 1 << 2 }

Protected Member Functions
	TerrainToolCollection ()
	Default constructor used in serialization.
virtual	~TerrainToolCollection ()
	Reference counted object - protected destructor.
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const
Protected Member Functions inherited from agxStream::Serializable
	Serializable ()
	Default constructor.
	Serializable (const Serializable &other)
	Copy constructor.
void	generateUuid ()

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Public Member Functions inherited from agxStream::Serializable
static void	setEnableUuidGeneration (bool flag)
	Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()
static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

Collection of terrain tool (currently Shovel) related objects which are terrain instance specific.

Definition at line 38 of file TerrainToolCollection.h.

Member Typedef Documentation

Flags

using agxTerrain::deprecated::TerrainToolCollection::Flags = agx::BitState<StateFlags, agx::UInt32>

protected

Definition at line 264 of file TerrainToolCollection.h.

Member Enumeration Documentation

StateFlags

enum agxTerrain::deprecated::TerrainToolCollection::StateFlags : agx::UInt32

protected

Enumerator
ENABLED
SHOVEL_ENABLED
SET_ZERO_AGGREGATE_VELOCITY

Definition at line 258 of file TerrainToolCollection.h.

Constructor & Destructor Documentation

TerrainToolCollection() [1/2]

agxTerrain::deprecated::TerrainToolCollection::TerrainToolCollection	(	Terrain *	terrain,
		Shovel *	shovel
	)

Deprecated:

Construct given terrain and shovel.

Parameters

terrain	- terrain instance this collection belongs to
shovel	- user shovel instance

TerrainToolCollection() [2/2]

agxTerrain::deprecated::TerrainToolCollection::TerrainToolCollection ( )

protected

Default constructor used in serialization.

~TerrainToolCollection()

virtual agxTerrain::deprecated::TerrainToolCollection::~TerrainToolCollection ( )

protectedvirtual

Reference counted object - protected destructor.

Member Function Documentation

clearActiveZoneWedges()

void agxTerrain::deprecated::TerrainToolCollection::clearActiveZoneWedges

(

)

const

Deprecated:

Clear the active zone wedges of the primary active zones and deformers

getActiveZone()

PrimaryActiveZone * agxTerrain::deprecated::TerrainToolCollection::getActiveZone

(

)

const

Deprecated:

Returns

shovel active zone specific for this terrain instance

getAggregateContactGenerator()

AggregateContactGenerator * agxTerrain::deprecated::TerrainToolCollection::getAggregateContactGenerator

(

)

const

Deprecated:

Returns

aggregate contact generator specific for this terrain instance

getAggregateTerrainContactDepth()

agx::Real agxTerrain::deprecated::TerrainToolCollection::getAggregateTerrainContactDepth

(

Shovel::ExcavationMode

excavationMode

)

const

Deprecated:

Returns

the current wedge aggregate depth in the specified collection given an excavation mode.

getDeformController()

DeformController * agxTerrain::deprecated::TerrainToolCollection::getDeformController

(

)

const

Deprecated:

Returns

aggregate contact generator specific for this terrain instance

getParentFrame()

agx::Frame * agxTerrain::deprecated::TerrainToolCollection::getParentFrame

(

)

const

Deprecated:

Returns

parent frame located at model center of the shovel

getPenetrationResistance()

SoilPenetrationResistance * agxTerrain::deprecated::TerrainToolCollection::getPenetrationResistance

(

)

const

Deprecated:

Returns

shovel penetration resistance specific for this terrain instance

getShovel()

Shovel * agxTerrain::deprecated::TerrainToolCollection::getShovel

(

)

const

Deprecated:

Returns

user shovel instance

getSoilParticleAggregate()

SoilParticleAggregate * agxTerrain::deprecated::TerrainToolCollection::getSoilParticleAggregate

(

)

const

Deprecated:

Returns

soil particle aggregate specific for this terrain instance

getTerrain()

Terrain * agxTerrain::deprecated::TerrainToolCollection::getTerrain

(

)

const

Deprecated:

Returns

terrain instance this collection belongs to

getUseCustomFricionModel()

bool agxTerrain::deprecated::TerrainToolCollection::getUseCustomFricionModel

(

)

const

Deprecated:

Returns

whenever custom friction models should be used in the shovel <-> aggregate contacts. (Default: true)

getVoxelCollisionGeometries()

const agxCollide::GeometryRefVector & agxTerrain::deprecated::TerrainToolCollection::getVoxelCollisionGeometries

(

)

const

Deprecated:

Returns

the shovel geometries colliding with voxels in the terrain

getWedgeAggregate()

const agx::RigidBody * agxTerrain::deprecated::TerrainToolCollection::getWedgeAggregate

(

Shovel::ExcavationMode

excavationMode

)

const

Deprecated:

Returns

the current wedge aggregate in the specified collection given an excavation mode if it exists, nullptr otherwise.

initialized()

agx::Bool agxTerrain::deprecated::TerrainToolCollection::initialized

(

)

const

Deprecated:

Returns

true if initialized (initializes in addNotification) - otherwise false

recomputeInnerShape()

void agxTerrain::deprecated::TerrainToolCollection::recomputeInnerShape

(

)

Deprecated:

Force re-computation of the inner shape

setEnableShovelTerrainGeometryContacts()

void agxTerrain::deprecated::TerrainToolCollection::setEnableShovelTerrainGeometryContacts

(

bool

enable

)

Deprecated:

Set if regular geometry contacts should be created between the shovel geometries and the associated terrain geometry.

setUseCustomFrictionModel()

void agxTerrain::deprecated::TerrainToolCollection::setUseCustomFrictionModel

(

bool

enable

)

setZeroAggregateVelocity()

void agxTerrain::deprecated::TerrainToolCollection::setZeroAggregateVelocity

(

bool

enable

)

Deprecated:

Set whenever the innerbody aggregate should have zero velocity before solve step as opposed to using particle or cached post-solve velocities from the previous time step.

Parameters

enable

- true if the innerbody aggregate should have zero velocity, false otherwise.

shouldUpdate()

agx::Bool agxTerrain::deprecated::TerrainToolCollection::shouldUpdate

(

)

Deprecated:

Returns

true if the ToolCollection should update in preCollide, pre and post

shovelEnableHasChanged()

bool agxTerrain::deprecated::TerrainToolCollection::shovelEnableHasChanged

(

)

const

Deprecated:

Returns

true if shovel enable has changed, mismatching the collection internal shovel enable variable

---

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

• TerrainToolCollection.h