tgBoxInfo Class Reference

#include <tgBoxInfo.h>

Inherits tgRigidInfo.

Inherited by tgBoxMoreAnchorsInfo, and tgGhostInfo.

Collaboration diagram for tgBoxInfo:

Public Member Functions
	tgBoxInfo (const tgBox::Config &config)
	tgBoxInfo (const tgBox::Config &config, tgTags tags)
	tgBoxInfo (const tgBox::Config &config, const tgPair &pair)
	tgBoxInfo (const tgBox::Config &config, tgTags tags, const tgPair &pair)
virtual	~tgBoxInfo ()
tgRigidInfo *	createRigidInfo (const tgPair &pair)
virtual void	initRigidBody (tgWorld &world)
virtual tgModel *	createModel (tgWorld &world)
const tgBox::Config &	getConfig () const
const btVector3 &	getFrom () const
const btVector3 &	getTo () const
virtual btCollisionShape *	getCollisionShape (tgWorld &world) const
virtual btTransform	getTransform () const
virtual double	getMass () const
virtual btVector3	getCenterOfMass () const
virtual btVector3	getConnectionPoint (const btVector3 &referencePoint, const btVector3 &destinationPoint) const
virtual btVector3	getConnectionPoint (const btVector3 &referencePoint, const btVector3 &destinationPoint, const double rotation) const
virtual tgCompoundRigidInfo *	getCompound ()
virtual const tgCompoundRigidInfo *	getCompound () const
virtual std::set< tgRigidInfo * >	getLeafRigids ()
virtual bool	containsNode (const btVector3 &nodeVector) const
virtual std::set< btVector3 >	getContainedNodes () const
double	getLength () const
virtual tgRigidInfo *	createRigidInfo (const tgNode &node)
virtual tgRigidInfo *	createRigidInfo (const tgNode &node, const tgTagSearch &tagSearch)
virtual tgRigidInfo *	createRigidInfo (const tgPair &pair, const tgTagSearch &tagSearch)
virtual std::vector < tgRigidInfo * >	createRigidInfos (const tgNodes &nodes, const tgTagSearch &tagSearch)
virtual std::vector < tgRigidInfo * >	createRigidInfos (const tgPairs &pairs, const tgTagSearch &tagSearch)
void	setCollisionShape (btCollisionShape *p_btCollisionShape)
virtual tgRigidInfo *	getRigidInfoGroup ()
virtual const tgRigidInfo *	getRigidInfoGroup () const
virtual void	setRigidInfoGroup (tgRigidInfo *rigidInfoGroup)
virtual btRigidBody *	getRigidBody ()
virtual const btRigidBody *	getRigidBody () const
virtual void	setRigidBody (btRigidBody *rigidBody)
virtual btCollisionObject *	getCollisionObject ()
virtual const btCollisionObject *	getCollisionObject () const
virtual void	setCollisionObject (btCollisionObject *collisionObject)
bool	isCompound () const
virtual bool	sharesNodesWith (const tgRigidInfo &other) const
void	addTags (const std::string &space_separated_tags)
void	addTags (const tgTags &tags)
bool	hasTag (const std::string tag) const
bool	hasAllTags (std::string tags)
bool	hasAnyTags (const std::string tags)
bool	hasNoTags ()
tgTags &	getTags ()
const tgTags &	getTags () const
void	setTags (tgTags tags)
std::string	getTagStr (std::string delim=" ") const

Protected Attributes
btCollisionShape *	m_collisionShape
tgRigidInfo *	m_rigidInfoGroup
btCollisionObject *	m_collisionObject

Detailed Description

Implementation of a box shape as defined by a 'from' point and a 'to' point. It also has length, width and density.

Definition at line 48 of file tgBoxInfo.h.

Constructor & Destructor Documentation

tgBoxInfo::tgBoxInfo

(

const tgBox::Config &

config

)

Construct a tgBoxInfo with just a config. The pair must be filled in later, or factory methods can be used to create instances with pairs.

Definition at line 44 of file tgBoxInfo.cpp.

Here is the caller graph for this function:

tgBoxInfo::tgBoxInfo	(	const tgBox::Config &	config,
		tgTags	tags
	)

Construct a tgBoxInfo with just a config and tags. The pair must be filled in later, or factory methods can be used to create instances with pairs.

Definition at line 50 of file tgBoxInfo.cpp.

tgBoxInfo::tgBoxInfo	(	const tgBox::Config &	config,
		const tgPair &	pair
	)

Construct a tgBoxInfo from its endpoints, radius and density.

Parameters

[in]	from	one endpoint
[in]	to	the other endpoint
[in]	config	contains the radius and density

Todo:

: make sure that tgPairs returns references to the vectors...

Definition at line 56 of file tgBoxInfo.cpp.

tgBoxInfo::tgBoxInfo	(	const tgBox::Config &	config,
		tgTags	tags,
		const tgPair &	pair
	)

Construct a tgBoxInfo from its endpoints, radius and density.

Parameters

[in]	from	one endpoint
[in]	to	the other endpoint
[in]	config	contains the radius and density

Todo:

: make sure that tgPairs returns references to the vectors...

Definition at line 62 of file tgBoxInfo.cpp.

virtual tgBoxInfo::~tgBoxInfo ( )

inlinevirtual

World will destroy the rigid body

Definition at line 86 of file tgBoxInfo.h.

Member Function Documentation

virtual bool tgBoxInfo::containsNode ( const btVector3 &  nodeVector ) const

inlinevirtual

Is the given vector either of the endpoints?

Return values

true	if nodeVector is either endpoint
false	if nodeVector is neither endpoint

Implements tgRigidInfo.

Reimplemented in tgBoxMoreAnchorsInfo.

Definition at line 198 of file tgBoxInfo.h.

Here is the call graph for this function:

tgRigidInfo * tgBoxInfo::createRigidInfo ( const tgPair &  pair )

virtual

Create a tgRigidInfo* from a tgPair

Reimplemented from tgRigidInfo.

Reimplemented in tgBoxMoreAnchorsInfo.

Definition at line 68 of file tgBoxInfo.cpp.

Here is the call graph for this function:

virtual btVector3 tgBoxInfo::getCenterOfMass ( ) const

inlinevirtual

Return the Box's center of mass. The center of mass is a point halfway between the endpoints.

Returns

the Box's center of mass

Implements tgRigidInfo.

Definition at line 141 of file tgBoxInfo.h.

Here is the call graph for this function:

virtual btCollisionObject* tgRigidInfo::getCollisionObject ( )

inlinevirtualinherited

Return a pointer to the collisionObject without upcasting

Returns

a pointer to the corresponding btCollisionObject

Reimplemented in tgCompoundRigidInfo.

Definition at line 190 of file tgRigidInfo.h.

Here is the caller graph for this function:

virtual const btCollisionObject* tgRigidInfo::getCollisionObject ( ) const

inlinevirtualinherited

Return a pointer to the collisionObject without upcasting

Returns

a pointer to the corresponding btCollisionObject

Reimplemented in tgCompoundRigidInfo.

Definition at line 199 of file tgRigidInfo.h.

btCollisionShape * tgBoxInfo::getCollisionShape ( tgWorld &  world ) const

virtual

Return a pointer to the corresponding btCollisionShape, lazily creating it if it does not exist.

Implements tgRigidInfo.

Definition at line 100 of file tgBoxInfo.cpp.

virtual tgCompoundRigidInfo* tgBoxInfo::getCompound ( )

inlinevirtual

Since a Box is not a compound shape, there is no compound shape object to return.

Return values

NULL

Implements tgRigidInfo.

Definition at line 176 of file tgBoxInfo.h.

virtual const tgCompoundRigidInfo* tgBoxInfo::getCompound ( ) const

inlinevirtual

Since a Box is not a compound shape, there is no compound shape object to return.

Return values

NULL

Implements tgRigidInfo.

Definition at line 183 of file tgBoxInfo.h.

const tgBox::Config& tgBoxInfo::getConfig ( ) const

inline

Return a const reference to the container of the radius and density.

Returns

a const reference to the container of the radius and density

Definition at line 107 of file tgBoxInfo.h.

btVector3 tgBoxInfo::getConnectionPoint ( const btVector3 &  referencePoint, const btVector3 &  destinationPoint  ) const

virtual

Return the surface point closest to the reference point in the direction of the destination point.

Parameters

[in]	referencePoint	a btVector
[in]	destinationPoint	a btVector

Returns

the surface point closest to the reference point in the direction of the destination point

Implements tgRigidInfo.

Definition at line 135 of file tgBoxInfo.cpp.

btVector3 tgBoxInfo::getConnectionPoint ( const btVector3 &  referencePoint, const btVector3 &  destinationPoint, const double  rotation  ) const

virtual

Return the surface point closest to the reference point in the direction of the destination point.

Parameters

[in]	referencePoint	a btVector
[in]	destinationPoint	a btVector

Returns

the surface point closest to the reference point in the direction of the destination point

Reimplemented from tgRigidInfo.

Definition at line 142 of file tgBoxInfo.cpp.

Here is the call graph for this function:

std::set< btVector3 > tgBoxInfo::getContainedNodes ( ) const

virtual

Return a set contiaining the two endpoints.

Returns

a set contiaining the two endpoints

Implements tgRigidInfo.

Definition at line 195 of file tgBoxInfo.cpp.

Here is the call graph for this function:

const btVector3& tgBoxInfo::getFrom ( ) const

inline

Return a const reference to the first endpoint.

Definition at line 110 of file tgBoxInfo.h.

Here is the call graph for this function:

std::set< tgRigidInfo * > tgBoxInfo::getLeafRigids ( )

virtual

Return a set containing only a pointer to this Box.

Return values

a	set containing only a pointer to this Box

Todo:

This function can't be const unless the return value is std::set<const tgRigidInfo*>.

Implements tgRigidInfo.

Reimplemented in tgBoxMoreAnchorsInfo.

Definition at line 188 of file tgBoxInfo.cpp.

double tgBoxInfo::getLength ( ) const

inline

Return the distance between the two endpoints.

Returns

the distance between the two endpoints

Definition at line 213 of file tgBoxInfo.h.

Here is the call graph for this function:

double tgBoxInfo::getMass ( ) const

virtual

Return the Box's mass. The mass is the volume times the density.

Returns

the mass of the Box

Implements tgRigidInfo.

Definition at line 119 of file tgBoxInfo.cpp.

Here is the call graph for this function:

btRigidBody * tgRigidInfo::getRigidBody ( )

virtualinherited

Return a pointer to the corresponding btRigidBody.

Returns

a pointer to the corresponding btRigidBody

Reimplemented in tgCompoundRigidInfo.

Definition at line 124 of file tgRigidInfo.cpp.

const btRigidBody * tgRigidInfo::getRigidBody ( ) const

virtualinherited

Return a const pointer to the corresponding btRigidBody.

Returns

a pointer to the corresponding btRigidBody

Reimplemented in tgCompoundRigidInfo.

Definition at line 130 of file tgRigidInfo.cpp.

virtual tgRigidInfo* tgRigidInfo::getRigidInfoGroup ( )

inlinevirtualinherited

Get the tgRigidInfo that represents the compound rigid that this rigid belongs to. If it doesn't share nodes with any other rigids (determined during auto-compounding), it will point to itself.

Definition at line 149 of file tgRigidInfo.h.

Here is the caller graph for this function:

const btVector3& tgBoxInfo::getTo ( ) const

inline

Return a const reference to the second endpoint.

Definition at line 113 of file tgBoxInfo.h.

Here is the call graph for this function:

virtual btTransform tgBoxInfo::getTransform ( ) const

inlinevirtual

Return a btTransform that maps the from endpoint to the to endpoint

Returns

a btTransform that maps the from endpoint to the to endpoint

Implements tgRigidInfo.

Definition at line 125 of file tgBoxInfo.h.

void tgBoxInfo::initRigidBody ( tgWorld &  world )

virtual

Call tgRigidInfo init rigid, then apply config to the rigid body.

Todo:

come up with a general solution in tgRigidInfo::initRigidBody Currently very difficult to pass around the config file in tgRigidInfo, since

Reimplemented from tgRigidInfo.

Reimplemented in tgGhostInfo.

Definition at line 73 of file tgBoxInfo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool tgRigidInfo::isCompound ( ) const

inlineinherited

Is this tgRigidInfo a compound?

Return values

true	if this tgRigidInfo is a compound
false	if this tgRigidInfo is not a compound

Todo:

Is this necessary?

Definition at line 273 of file tgRigidInfo.h.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void tgRigidInfo::setCollisionObject ( btCollisionObject *  collisionObject )

inlinevirtualinherited

Set the collision object to a new collision object

Returns

a pointer to the corresponding btCollisionObject

Todo:

Does this leak any previous value of m_collisionObject?

Reimplemented in tgCompoundRigidInfo.

Definition at line 208 of file tgRigidInfo.h.

Here is the caller graph for this function:

void tgRigidInfo::setCollisionShape ( btCollisionShape *  p_btCollisionShape )

inlineinherited

Set the corresponding btCollisionShape.

Parameters

[in,out]

a

pointer to a btCollisionShape

Todo:

Does this leak any previous value of m_collisionShape?

Definition at line 137 of file tgRigidInfo.h.

void tgRigidInfo::setRigidBody ( btRigidBody *  rigidBody )

virtualinherited

Set the corresponding btRigidBody.

Parameters

[in,out]

a

pointer to a btRigidBody

Todo:

Does this leak any previous value of m_collisionObject?

Reimplemented in tgCompoundRigidInfo.

Definition at line 135 of file tgRigidInfo.cpp.

virtual void tgRigidInfo::setRigidInfoGroup ( tgRigidInfo *  rigidInfoGroup )

inlinevirtualinherited

Set the tgRigidInfo that represents the compound rigid that this may belong to. This will be set during auto-compounding.

Definition at line 163 of file tgRigidInfo.h.

bool tgRigidInfo::sharesNodesWith ( const tgRigidInfo &  other ) const

virtualinherited

Does this rigid have any nodes in common with the given tgRigidInfo object?

Parameters

in]	other a reference to a tgRigidInfo object

Return values

true	if any node in this sphere is also in other
false	if no node in this sphere is also in other

Reimplemented in tgCompoundRigidInfo.

Definition at line 141 of file tgRigidInfo.cpp.

Here is the call graph for this function:

Member Data Documentation

btCollisionObject* tgRigidInfo::m_collisionObject

mutableprotectedinherited

A pointer to the corresponding btCollisionObject. Typically a btRigidBody, but can also be a btGhostObject

Definition at line 347 of file tgRigidInfo.h.

btCollisionShape* tgRigidInfo::m_collisionShape

mutableprotectedinherited

A pointer to the corresponding btCollisionShape.

Definition at line 332 of file tgRigidInfo.h.

tgRigidInfo* tgRigidInfo::m_rigidInfoGroup

mutableprotectedinherited

A pointer to a group of rigids to which this rigid belongs. This is set during the rigid grouping step by a StructureInfo. If this is not set, getRigidGroup() will return a pointer to this (effectively, "I'm in my own group")

Definition at line 341 of file tgRigidInfo.h.

---

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

• tgcreator/tgBoxInfo.h
• tgcreator/tgBoxInfo.cpp