A Collection is a collection of basic simulation objects, such as rigid bodies, constraints, geometries. More...

#include <Collection.h>

Inheritance diagram for agxSDK::Collection:

Public Member Functions
	Collection ()
	Default constructor.

virtual bool	add (agx::ParticleSystem *particleSystem)
	Add a particle system to this assembly.

virtual bool	remove (agx::ParticleSystem *particleSystem)
	Remove a particle system from this assembly param particleSystem - The particle system to removed.

Public Member Functions inherited from agxSDK::Assembly
	Assembly ()
	Default constructor.

bool	add (agx::Constraint *constraint)
	Add a constraint to the assembly.

bool	add (agx::ContactMaterial *contactMaterial)
	Add a contact material to this assembly.

bool	add (agx::Emitter *emitter)
	Add an emitter to this assembly.

bool	add (agx::Interaction *interaction)
	Add an interaction to this assembly.

bool	add (agx::MergedBody *mergedBody)
	Add a MergedBody to this assembly.

bool	add (agx::ObserverFrame *observerFrame)
	Add an ObserverFrame to this assembly.

bool	add (agx::RigidBody *body)
	Add a rigid body to the assembly.

bool	add (agxCollide::Geometry *geometry)
	Add a geometry to the assembly.

bool	add (agxSDK::EventListener *listener)
	Add a listener to the assembly.

bool	add (agxSDK::TerrainInstance *terrainInstance)
	Add a TerrainInstance to this assembly.

bool	add (agxSDK::TerrainToolInstance *toolInstance)
	Add a TerrainToolInstance to this assembly.

bool	add (agxStream::Serializable *object)
	Add an object of type serialized.

bool	add (Assembly *assembly)
	Add another assembly as child to this assembly.

virtual void	addNotification (agxSDK::Simulation *)
	Called when this assembly is added to a simulation (given that it not already is in the simulation).

virtual void	addNotification (Assembly *)
	Called when this assembly is added to another assembly.

	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxSDK::Assembly)

size_t	collect (agx::ConstraintRefVector &result, bool recursive=true)

size_t	collect (agx::EmitterRefVector &result, bool recursive=true)

size_t	collect (agx::InteractionRefVector &result, bool recursive=true)

size_t	collect (agx::MergedBodyRefVector &result, bool recursive=true)

size_t	collect (agx::ObserverFrameRefVector &result, bool recursive=true)

size_t	collect (agx::ParticleSystemRefVector &result, bool recursive=true)

size_t	collect (agx::RigidBodyRefVector &result, bool recursive=true)

size_t	collect (agxCollide::GeometryRefVector &result, bool recursive=true)

size_t	collect (agxSDK::AssemblyRefVector &result, bool recursive=true)

size_t	collect (agxSDK::EventListenerRefVector &result, bool recursive=true)

size_t	collect (agxSDK::TerrainInstanceRefVector &result, bool recursive=true)

size_t	collect (agxSDK::TerrainToolInstanceRefVector &result, bool recursive=true)

bool	empty () const

const AssemblyRefSetVector &	getAssemblies () const

agxSDK::Assembly *	getAssembly (const agx::Name &name, bool recursive=true)
	Find (linear search) and return named Assembly.

const agxSDK::Assembly *	getAssembly (const agx::Name &name, bool recursive=true) const
	Find (linear search) and return named Assembly.

agxSDK::Assembly *	getAssembly (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return an Assembly matching the given uuid.

const agxSDK::Assembly *	getAssembly (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return an Assembly matching the given uuid.

agx::Constraint *	getConstraint (const agx::Name &name, bool recursive=true)
	Find (linear search) and return named Constraint.

template<typename T >
T *	getConstraint (const agx::Name &name, bool recursive=true)
	Find and return named Constraint of a template type, for example Hinge:

const agx::Constraint *	getConstraint (const agx::Name &name, bool recursive=true) const
	Find (linear search) and return named Constraint.

template<typename T >
const T *	getConstraint (const agx::Name &name, bool recursive=true) const
	Find and return named Constraint of a template type, for example Hinge:

agx::Constraint *	getConstraint (const agx::Uuid &uuid, bool recursive=true)
	Find and return a pointer to a Constraint with the given uuid.

const agx::Constraint *	getConstraint (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return a pointer to a Constraint with the given uuid.

agx::Constraint1DOF *	getConstraint1DOF (const agx::Name &name, bool recursive=true)

agx::Constraint2DOF *	getConstraint2DOF (const agx::Name &name, bool recursive=true)

const agx::ConstraintRefSetVector &	getConstraints () const

const agx::EmitterRefSetVector &	getEmitters () const

const EventListenerRefSetVector &	getEventListeners () const

virtual agx::Frame *	getFrame ()
	Return a reference to the frame containing transformation and velocity information for this assembly.

virtual const agx::Frame *	getFrame () const

const agxCollide::GeometryRefSetVector &	getGeometries () const

agxCollide::Geometry *	getGeometry (const agx::Name &name, bool recursive=true)
	Find (linear search) and return named collision Geometry.

const agxCollide::Geometry *	getGeometry (const agx::Name &name, bool recursive=true) const
	Find (linear search) and return named collision Geometry.

agxCollide::Geometry *	getGeometry (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return a Geometry matching the given uuid.

const agxCollide::Geometry *	getGeometry (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return a Geometry matching the given uuid.

const agx::InteractionRefSetVector &	getInteractions () const

agx::Vec3	getLocalPosition () const

agx::Quat	getLocalRotation () const

const agx::AffineMatrix4x4 &	getLocalTransform () const

const agx::MergedBodyRefSetVector &	getMergedBodies () const

agx::MergedBody *	getMergedBody (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return an MergedBody matching the given uuid.

const agx::MergedBody *	getMergedBody (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return an MergedBody matching the given uuid.

agx::Name	getName () const

agx::ObserverFrame *	getObserverFrame (const agx::Name &name, bool recursive=true)
	Find (linear search) and return an ObserverFrame matching the given uuid.

const agx::ObserverFrame *	getObserverFrame (const agx::Name &name, bool recursive=true) const
	Find (linear search) and return an ObserverFrame matching the given uuid.

agx::ObserverFrame *	getObserverFrame (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return an ObserverFrame matching the given uuid.

const agx::ObserverFrame *	getObserverFrame (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return an ObserverFrame matching the given uuid.

const agx::ObserverFrameRefSetVector &	getObserverFrames () const

Assembly *	getParent ()

const Assembly *	getParent () const

agx::Frame *	getParentFrame ()

const agx::Frame *	getParentFrame () const

const agx::ParticleSystemRefSetVector &	getParticleSystems () const

const agx::RigidBodyRefSetVector &	getRigidBodies () const

agx::RigidBody *	getRigidBody (const agx::Name &name, bool recursive=true)
	Find (linear search) and return named RigidBody.

const agx::RigidBody *	getRigidBody (const agx::Name &name, bool recursive=true) const
	Find (linear search) and return named RigidBody.

agx::RigidBody *	getRigidBody (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return a pointer to a RigidBody with the given uuid.

const agx::RigidBody *	getRigidBody (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return a pointer to a RigidBody with the given uuid.

agxSDK::Simulation *	getSimulation ()

const agxSDK::Simulation *	getSimulation () const

agxSDK::TerrainInstance *	getTerrainInstance (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return an TerrainInstance matching the given uuid.

const agxSDK::TerrainInstance *	getTerrainInstance (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return an TerrainInstance matching the given uuid.

const agxSDK::TerrainInstanceRefSetVector &	getTerrainInstances () const

agxSDK::TerrainToolInstance *	getTerrainToolInstance (const agx::Uuid &uuid, bool recursive=true)
	Find (linear search) and return an TerrainToolInstance matching the given uuid.

const agxSDK::TerrainToolInstance *	getTerrainToolInstance (const agx::Uuid &uuid, bool recursive=true) const
	Find (linear search) and return an TerrainToolInstance matching the given uuid.

const agxSDK::TerrainToolInstanceRefSetVector &	getTerrainToolInstances () const

Type	getType () const

bool	remove (agx::Constraint *constraint)
	Remove a constraint from this assembly (does not recurse down in tree).

bool	remove (agx::ContactMaterial *contactMaterial)
	Remove a contact material from this assembly.

bool	remove (agx::Emitter *emitter)
	Remove an emitter from this assembly.

bool	remove (agx::Interaction *interaction)
	Remove an interaction from this assembly.

bool	remove (agx::MergedBody *mergedBody)
	Remove a MergedBody from this assembly.

bool	remove (agx::ObserverFrame *observerFrame, bool resetParentFrame=true)
	Remove an ObserverFrame from this assembly.

bool	remove (agx::RigidBody *body, bool removeAssociatedGeometries=false, bool resetParentFrame=true)
	Remove a rigid body from this assembly (does not recurse down in tree).

bool	remove (agxCollide::Geometry *geometry, bool resetParentFrame=true)
	Remove a geometry from this assembly (does not recurse down in tree).

bool	remove (agxSDK::TerrainInstance *terrainInstance)
	Remove a TerrainInstance from this assembly.

bool	remove (agxSDK::TerrainToolInstance *toolInstance)
	Remove a TerrainToolInstance from this assembly.

bool	remove (Assembly *assembly, bool resetParentFrame=true)
	Remove a child assembly from a parent.

bool	remove (EventListener *listener)
	Remove an EventListener from the assembly.

virtual void	removeNotification (agxSDK::Simulation *)
	Called when this assembly is removed from a simulation.

virtual void	removeNotification (Assembly *)
	Called when this assembly is removed from another assembly.

bool	reset (bool resetParentFrame=true)
	If this assembly is not added to a simulation it will clear all added bodies etc.

virtual void	setAngularVelocity (const agx::Vec3 &velocity)
	Set the angular velocity (in world frame) recursively for all rigid bodies stored in assembly.

void	setLocalPosition (agx::Real x, agx::Real y, agx::Real z)
	Set the position of the assembly relative to its frame's parent frame.

void	setLocalPosition (const agx::Vec3 &p)
	Set the position of the assembly relative to its frame's parent frame.

void	setLocalRotation (const agx::EulerAngles &e)
	Set the rotation of the assembly relative to its frame's parent frame.

void	setLocalRotation (const agx::Quat &q)
	Set the rotation of the assembly relative to its frame's parent frame.

void	setLocalTransform (const agx::AffineMatrix4x4 &matrix)
	Assign the local transformation matrix for this assembly, ignoring any eventual parent transformation.

void	setName (const agx::Name &name)
	Set the name of this Assembly.

bool	setParentFrame (agx::Frame *frame)
	Set the parent frame of this assembly's frame.

void	setPosition (agx::Real x, agx::Real y, agx::Real z)
	Set the position of the frame in world coordinates.

void	setPosition (const agx::Vec3 &p)
	Set the position of the frame in world coordinates.

void	setRotation (const agx::EulerAngles &e)
	Set the rotation of the assembly relative to world frame.

void	setRotation (const agx::OrthoMatrix3x3 &m)
	Set the rotation of the assembly relative to world frame.

void	setRotation (const agx::Quat &q)
	Set the rotation of the assembly relative to world frame.

void	setTransform (const agx::AffineMatrix4x4 &matrix)
	Set the transform of the assembly.

virtual void	setVelocity (const agx::Vec3 &velocity)
	Set the linear velocity (in world frame) recursively for all rigid bodies stored in assembly.

bool	transfer (agxSDK::Assembly *target)
	Transfer all the content from this assembly to the `target`, including name and transformation.

virtual void	traverse (AssemblyVisitor *visitor)
	Traverse the assembly tree recursively using a visitor.

virtual void	traverse (const AssemblyVisitor *visitor) 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 Member Functions
virtual	~Collection ()

	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agxSDK::Collection)

Protected Member Functions inherited from agxSDK::Assembly
	Assembly (Type type)

virtual	~Assembly ()
	Destructor.

bool	addParticleSystem (agx::ParticleSystem *particleSystem)
	Add a particle system to this assembly.

void	addToSimulation (Simulation *simulation)

void	removeFromSimulation (Simulation *simulation)

bool	removeParticleSystem (agx::ParticleSystem *particleSystem)
	Remove a particle system from this assembly.

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
static agxStream::Serializable *	create (agxStream::InputArchive &)

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.

Additional Inherited Members
Public Types inherited from agxSDK::Assembly
enum	Type { ASSEMBLY , COLLECTION }
	Specifies the type an assembly is. More...

Static Public Member Functions inherited from agxSDK::Assembly
static Assembly *	asAssembly (agxStream::Serializable *obj)

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.

Protected Attributes inherited from agx::Referenced
Mutex	m_mutex

ObserverContainer	m_observers

AtomicValue	m_refCount

Detailed Description

A Collection is a collection of basic simulation objects, such as rigid bodies, constraints, geometries.

The assembly may also contain other assemblies, which enables a hierarchical structuring of the simulation, allowing manipulation at different conceptual levels.

The difference from Assembly, is that Collection does NOT build a Transformation hierarchy. It is merely for collecting objects without any Frame structure.

The assembly tree can be traversed using an AssemblyVisitor.

Definition at line 34 of file Collection.h.

Constructor & Destructor Documentation

◆ Collection()

agxSDK::Collection::Collection ( )

Default constructor.

◆ ~Collection()

virtual agxSDK::Collection::~Collection ( )

protectedvirtual

Member Function Documentation

◆ add()

virtual bool agxSDK::Collection::add ( agx::ParticleSystem * particleSystem )

virtual

Add a particle system to this assembly.

ParticleSystems should only be added to Collections. param particleSystem - The particle system to be added

Returns: true if it succeeds.

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agxSDK::Collection::AGXSTREAM_DECLARE_SERIALIZABLE_BASE ( agxSDK::Collection )

protected

◆ create()

static agxStream::Serializable * agxSDK::Collection::create ( agxStream::InputArchive & )

inlinestaticprotected

Definition at line 60 of file Collection.h.

◆ remove()

virtual bool agxSDK::Collection::remove ( agx::ParticleSystem * particleSystem )

virtual

Remove a particle system from this assembly param particleSystem - The particle system to removed.

Returns: true if it succeeds

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

Collection.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members