agxTerrain::GroundCollapse::CollapseSettings Class Reference

#include <CollapseSettings.h>

Inheritance diagram for agxTerrain::GroundCollapse::CollapseSettings:

Public Types
using	Flags = agx::BitState< StateFlags, agx::UInt32 >
enum	StateFlags : agx::UInt32 {   USE_CUSTOM_CONTACT_MATERIAL = 1 << 0 , STOP_AFTER_FIRST_FAILURE = 1 << 1 , SHOULD_COLLAPSE_SOIL = 1 << 2 , SHOULD_SAVE_SUBSTEP_RESULTS = 1 << 3 ,   ENABLE_PARALLEL_SOLVE = 1 << 4 , USE_CUSTOM_SURFACES = 1 << 5 , USE_HOLONOMIC_CONTACTS = 1 << 6 }

Public Member Functions
	CollapseSettings ()
	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxTerrain::GroundCollapse::CollapseSettings)
agx::Real	getAggregateContactViscosity () const
agx::Vec2	getContactShrinkFactor () const
agx::ContactMaterial *	getCustomContactMaterial () const
bool	getEnableDynamicCollapse () const
bool	getEnableParallelSolve () const
bool	getEnableSubStepResults () const
agx::Real	getLinearAccelerationThreshold () const
agx::Real	getLowerPointSpanOffset ()
agx::Real	getLowerPointSpanScaleFactor () const
agx::UInt	getNumIntersectionPoints ()
agx::UInt	getNumLowerPoints ()
agx::UInt	getNumSimulationSubsteps ()
agx::UInt	getNumUpperPoints ()
GroundCollapse::PointConfiguration	getPointConfiguration () const
agx::UInt	getRadiusNumber ()
bool	getShouldStopAfterFirstFailure () const
agx::Real	getSimulationFrequency ()
agx::FrictionModel::SolveType	getSolveType () const
agx::Real	getUpperPointSpanOffset () const
bool	getUseCustomContactMaterial () const
bool	getUseCustomFailureSurfaces () const
bool	getUseHolonomicContacts () const
void	setAggregateContactViscosity (agx::Real viscosity)
void	setContactShrinkFactor (const agx::Vec2 &contactShrinkFactor)
void	setCustomContactMaterial (agx::ContactMaterial *cm)
void	setEnableDynamicCollapse (bool enable)
void	setEnableParallelSolve (bool enable)
void	setEnableSubStepResults (bool enable)
void	setLinearAccelerationThreshold (agx::Real threshold)
void	setLowerPointSpanOffset (agx::Real offset)
void	setLowerPointSpanScaleFactor (agx::Real scaleFactor)
void	setNumIntersectionPoints (agx::UInt numIntersectionPoints)
void	setNumLowerPoints (agx::UInt numLowerPoints)
void	setNumSimulationSubsteps (agx::UInt numSimulationSubSteps)
void	setNumUpperPoints (agx::UInt numUpperPoints)
void	setPointConfiguration (const GroundCollapse::PointConfiguration &pointConfiguration)
void	setRadiusNumber (agx::UInt radiusNumber)
void	setShouldStopAfterFirstFailure (bool shouldStop)
void	setSimulationFrequency (agx::Real simulationFrequency)
void	setSolveType (agx::FrictionModel::SolveType setSolveType)
void	setUpperPointSpanOffset (agx::Real offsetFraction)
void	setUseCustomContactMaterial (bool enable)
void	setUseCustomFailureSurfaces (bool enable)
void	setUseHolonomicContacts (bool enable)
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.

Static Public Member Functions
static agxStream::Serializable *	create (agxStream::InputArchive &)
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.

Additional Inherited Members
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 ()
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

Definition at line 35 of file CollapseSettings.h.

Member Typedef Documentation

Flags

using agxTerrain::GroundCollapse::CollapseSettings::Flags = agx::BitState<StateFlags, agx::UInt32>

Definition at line 307 of file CollapseSettings.h.

Member Enumeration Documentation

StateFlags

enum agxTerrain::GroundCollapse::CollapseSettings::StateFlags : agx::UInt32

Enumerator
USE_CUSTOM_CONTACT_MATERIAL
STOP_AFTER_FIRST_FAILURE
SHOULD_COLLAPSE_SOIL
SHOULD_SAVE_SUBSTEP_RESULTS
ENABLE_PARALLEL_SOLVE
USE_CUSTOM_SURFACES
USE_HOLONOMIC_CONTACTS

Definition at line 297 of file CollapseSettings.h.

Constructor & Destructor Documentation

CollapseSettings()

agxTerrain::GroundCollapse::CollapseSettings::CollapseSettings

(

)

Member Function Documentation

AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxTerrain::GroundCollapse::CollapseSettings::AGXSTREAM_DECLARE_SERIALIZABLE_BASE

(

agxTerrain::GroundCollapse::CollapseSettings

)

create()

static agxStream::Serializable * agxTerrain::GroundCollapse::CollapseSettings::create ( agxStream::InputArchive &  )

inlinestatic

Definition at line 309 of file CollapseSettings.h.

getAggregateContactViscosity()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getAggregateContactViscosity

(

)

const

getContactShrinkFactor()

agx::Vec2 agxTerrain::GroundCollapse::CollapseSettings::getContactShrinkFactor

(

)

const

getCustomContactMaterial()

agx::ContactMaterial * agxTerrain::GroundCollapse::CollapseSettings::getCustomContactMaterial

(

)

const

getEnableDynamicCollapse()

bool agxTerrain::GroundCollapse::CollapseSettings::getEnableDynamicCollapse

(

)

const

getEnableParallelSolve()

bool agxTerrain::GroundCollapse::CollapseSettings::getEnableParallelSolve

(

)

const

getEnableSubStepResults()

bool agxTerrain::GroundCollapse::CollapseSettings::getEnableSubStepResults

(

)

const

getLinearAccelerationThreshold()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getLinearAccelerationThreshold

(

)

const

getLowerPointSpanOffset()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getLowerPointSpanOffset

(

)

getLowerPointSpanScaleFactor()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getLowerPointSpanScaleFactor

(

)

const

getNumIntersectionPoints()

agx::UInt agxTerrain::GroundCollapse::CollapseSettings::getNumIntersectionPoints ( )

inline

Definition at line 148 of file CollapseSettings.h.

getNumLowerPoints()

agx::UInt agxTerrain::GroundCollapse::CollapseSettings::getNumLowerPoints ( )

inline

Definition at line 48 of file CollapseSettings.h.

getNumSimulationSubsteps()

agx::UInt agxTerrain::GroundCollapse::CollapseSettings::getNumSimulationSubsteps ( )

inline

Definition at line 217 of file CollapseSettings.h.

getNumUpperPoints()

agx::UInt agxTerrain::GroundCollapse::CollapseSettings::getNumUpperPoints ( )

inline

Definition at line 59 of file CollapseSettings.h.

getPointConfiguration()

GroundCollapse::PointConfiguration agxTerrain::GroundCollapse::CollapseSettings::getPointConfiguration

(

)

const

getRadiusNumber()

agx::UInt agxTerrain::GroundCollapse::CollapseSettings::getRadiusNumber ( )

inline

Definition at line 69 of file CollapseSettings.h.

getShouldStopAfterFirstFailure()

bool agxTerrain::GroundCollapse::CollapseSettings::getShouldStopAfterFirstFailure

(

)

const

getSimulationFrequency()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getSimulationFrequency ( )

inline

Definition at line 228 of file CollapseSettings.h.

getSolveType()

agx::FrictionModel::SolveType agxTerrain::GroundCollapse::CollapseSettings::getSolveType

(

)

const

getUpperPointSpanOffset()

agx::Real agxTerrain::GroundCollapse::CollapseSettings::getUpperPointSpanOffset

(

)

const

getUseCustomContactMaterial()

bool agxTerrain::GroundCollapse::CollapseSettings::getUseCustomContactMaterial

(

)

const

getUseCustomFailureSurfaces()

bool agxTerrain::GroundCollapse::CollapseSettings::getUseCustomFailureSurfaces

(

)

const

getUseHolonomicContacts()

bool agxTerrain::GroundCollapse::CollapseSettings::getUseHolonomicContacts

(

)

const

setAggregateContactViscosity()

void agxTerrain::GroundCollapse::CollapseSettings::setAggregateContactViscosity

(

agx::Real

viscosity

)

setContactShrinkFactor()

void agxTerrain::GroundCollapse::CollapseSettings::setContactShrinkFactor

(

const agx::Vec2 &

contactShrinkFactor

)

setCustomContactMaterial()

void agxTerrain::GroundCollapse::CollapseSettings::setCustomContactMaterial

(

agx::ContactMaterial *

cm

)

setEnableDynamicCollapse()

void agxTerrain::GroundCollapse::CollapseSettings::setEnableDynamicCollapse

(

bool

enable

)

setEnableParallelSolve()

void agxTerrain::GroundCollapse::CollapseSettings::setEnableParallelSolve

(

bool

enable

)

setEnableSubStepResults()

void agxTerrain::GroundCollapse::CollapseSettings::setEnableSubStepResults

(

bool

enable

)

setLinearAccelerationThreshold()

void agxTerrain::GroundCollapse::CollapseSettings::setLinearAccelerationThreshold

(

agx::Real

threshold

)

setLowerPointSpanOffset()

void agxTerrain::GroundCollapse::CollapseSettings::setLowerPointSpanOffset

(

agx::Real

offset

)

setLowerPointSpanScaleFactor()

void agxTerrain::GroundCollapse::CollapseSettings::setLowerPointSpanScaleFactor

(

agx::Real

scaleFactor

)

setNumIntersectionPoints()

void agxTerrain::GroundCollapse::CollapseSettings::setNumIntersectionPoints ( agx::UInt  numIntersectionPoints )

inline

Definition at line 142 of file CollapseSettings.h.

setNumLowerPoints()

void agxTerrain::GroundCollapse::CollapseSettings::setNumLowerPoints ( agx::UInt  numLowerPoints )

inline

Definition at line 44 of file CollapseSettings.h.

setNumSimulationSubsteps()

void agxTerrain::GroundCollapse::CollapseSettings::setNumSimulationSubsteps ( agx::UInt  numSimulationSubSteps )

inline

Definition at line 223 of file CollapseSettings.h.

setNumUpperPoints()

void agxTerrain::GroundCollapse::CollapseSettings::setNumUpperPoints ( agx::UInt  numUpperPoints )

inline

Definition at line 55 of file CollapseSettings.h.

setPointConfiguration()

void agxTerrain::GroundCollapse::CollapseSettings::setPointConfiguration

(

const GroundCollapse::PointConfiguration &

pointConfiguration

)

setRadiusNumber()

void agxTerrain::GroundCollapse::CollapseSettings::setRadiusNumber ( agx::UInt  radiusNumber )

inline

Definition at line 65 of file CollapseSettings.h.

setShouldStopAfterFirstFailure()

void agxTerrain::GroundCollapse::CollapseSettings::setShouldStopAfterFirstFailure

(

bool

shouldStop

)

setSimulationFrequency()

void agxTerrain::GroundCollapse::CollapseSettings::setSimulationFrequency

(

agx::Real

simulationFrequency

)

setSolveType()

void agxTerrain::GroundCollapse::CollapseSettings::setSolveType

(

agx::FrictionModel::SolveType

setSolveType

)

setUpperPointSpanOffset()

void agxTerrain::GroundCollapse::CollapseSettings::setUpperPointSpanOffset

(

agx::Real

offsetFraction

)

setUseCustomContactMaterial()

void agxTerrain::GroundCollapse::CollapseSettings::setUseCustomContactMaterial

(

bool

enable

)

setUseCustomFailureSurfaces()

void agxTerrain::GroundCollapse::CollapseSettings::setUseCustomFailureSurfaces

(

bool

enable

)

setUseHolonomicContacts()

void agxTerrain::GroundCollapse::CollapseSettings::setUseHolonomicContacts

(

bool

enable

)

---

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

• CollapseSettings.h