NTRT Simulator  Version: Master
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
tgCraterShallow Class Reference

#include <tgCraterShallow.h>

Inheritance diagram for tgCraterShallow:
Collaboration diagram for tgCraterShallow:

Public Member Functions

 tgCraterShallow ()
 
 tgCraterShallow (btVector3 origin)
 
virtual ~tgCraterShallow ()
 
virtual void setup (tgWorld &world)
 
virtual void step (double dt)
 
virtual void onVisit (tgModelVisitor &r)
 
void teardown ()
 
void attach (tgObserver< tgCraterShallow > *pObserver)
 
void notifyStep (double dt)
 
void notifySetup ()
 
void notifyTeardown ()
 
virtual void onVisit (const tgModelVisitor &r) const
 
void addChild (tgModel *pChild)
 
virtual std::string toString (std::string prefix="") const
 
template<typename T >
std::vector< T * > find (const tgTagSearch &tagSearch)
 
template<typename T >
std::vector< T * > find (const std::string &tagSearch)
 
std::vector< tgModel * > getDescendants () const
 
const std::vector
< abstractMarker > & 
getMarkers () const
 
void addMarker (abstractMarker a)
 
virtual std::vector
< tgSenseable * > 
getSenseableDescendants () 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 ()
 
tgTagsgetTags ()
 
const tgTagsgetTags () const
 
void setTags (tgTags tags)
 
std::string getTagStr (std::string delim=" ") const
 

Detailed Description

Class that creates box "models" that act as crater walls

Definition at line 45 of file tgCraterShallow.h.

Constructor & Destructor Documentation

tgCraterShallow::tgCraterShallow ( )

Default constructor. Sets center point of crater to (0,0,0)

Definition at line 63 of file tgCraterShallow.cpp.

tgCraterShallow::tgCraterShallow ( btVector3  origin)

Origin constructor. Sets center point to input param 'origin'.

Parameters
[in]origin- the center point of the tgCraterShallow object

Definition at line 67 of file tgCraterShallow.cpp.

tgCraterShallow::~tgCraterShallow ( )
virtual

Destructor. Deletes controllers, if any were added during setup. Teardown handles everything else.

Definition at line 71 of file tgCraterShallow.cpp.

Member Function Documentation

void tgModel::addChild ( tgModel pChild)
inherited

Add a sub-model to this model. The model takes ownership of the child sub-model and is responsible for deallocating it.

Parameters
[in,out]pChilda pointer to a sub-model
Exceptions
std::invalid_argumentis pChild is NULL, this object, or already a descendant
Todo:
Make sure that every child appears no more than once in the tree.

Definition at line 122 of file tgModel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void tgSubject< tgCraterShallow >::attach ( tgObserver< tgCraterShallow > *  pObserver)
inherited

Attach an observer to the subject of the observer.

Parameters
[in,out]pObservera pointer to an observer for the subject; do nothing if the pointer is NULL
template<typename T >
std::vector<T*> tgModel::find ( const tgTagSearch tagSearch)
inlineinherited

Get a vector of descendants sorted by type and a tagsearch. Useful for pulling out muscle groups, or similar.

Parameters
[in]tagSearch,atagSearch that contains the desired tags
Returns
a std::vector of pointers to members that match the tag search and typename T

Definition at line 128 of file tgModel.h.

Here is the call graph for this function:

template<typename T >
std::vector<T*> tgModel::find ( const std::string &  tagSearch)
inlineinherited

Get a vector of descendants sorted by type and a tagsearch. Useful for pulling out muscle groups, or similar.

Parameters
[in]tagSearch,astd::string& that contains the desired tags
Returns
a std::vector of pointers to members that match the tag search and typename T

Definition at line 141 of file tgModel.h.

Here is the call graph for this function:

std::vector< tgModel * > tgModel::getDescendants ( ) const
inherited

Return a std::vector of const pointers to all sub-models.

Todo:
examine whether this should be public, and perhaps create a read only version
Returns
a std::vector of const pointers all sub-models.
Todo:
Unnecessary copying can be avoided by pasing the result collection in the recursive step.

Definition at line 170 of file tgModel.cpp.

Here is the call graph for this function:

std::vector< tgSenseable * > tgModel::getSenseableDescendants ( ) const
virtualinherited

From tgSenseable: need to return all the children of this class. Since tgModels are tgSenseables, just return getDescendants().

Returns
a vector of tgModels, with pointers changed into pointers for tgSenseables.

For tgSenseable: just return the results of getDescendants here. This should be OK, since a vector of tgModel* is also a vector of tgSenseable*.

Reimplemented from tgSenseable.

Definition at line 191 of file tgModel.cpp.

Here is the call graph for this function:

void tgSubject< tgCraterShallow >::notifySetup ( )
inherited

Call tgObserver<T>::onSetup() on all observers in the order in which they were attached.

Here is the caller graph for this function:

void tgSubject< tgCraterShallow >::notifyStep ( double  dt)
inherited

Call tgObserver<T>::onStep() on all observers in the order in which they were attached.

Parameters
[in]dtthe number of seconds since the previous call; do nothing if not positive

Here is the caller graph for this function:

void tgSubject< tgCraterShallow >::notifyTeardown ( )
inherited

Call tgObserver<T>::onTeardown() on all observers in the order in which they were attached.

Here is the caller graph for this function:

void tgCraterShallow::onVisit ( tgModelVisitor r)
virtual

Receives a tgModelVisitor and dispatches itself into the visitor's "render" function. This model will go to the default tgModel function, which does nothing.

Parameters
[in]r- a tgModelVisitor which will pass this model back to itself

Definition at line 108 of file tgCraterShallow.cpp.

Here is the call graph for this function:

void tgModel::onVisit ( const tgModelVisitor r) const
virtualinherited

Call tgModelVisitor::render() on self and all descendants.

Parameters
[in,out]ra reference to a tgModelVisitor

Reimplemented in tgCompressionSpringActuator, tgUnidirComprSprActuator, ConnectorTestModel, BuildTestModel, tgKinematicActuator, tgSphere, tgBox, tgRod, ContactCableDemo, tgBasicActuator, hillyMuscleNP, simpleMuscleNP, tgBoxMoreAnchors, tgBaseRigid, and tgGhostModel.

Definition at line 107 of file tgModel.cpp.

Here is the call graph for this function:

void tgCraterShallow::setup ( tgWorld world)
virtual

Create the model.

Parameters
[in]world- the world we're building into

Reimplemented from tgModel.

Definition at line 73 of file tgCraterShallow.cpp.

void tgCraterShallow::step ( double  dt)
virtual

Step the model, its children. Notifies controllers of step.

Parameters
[in]dt,thetimestep. Must be positive.

Reimplemented from tgModel.

Definition at line 97 of file tgCraterShallow.cpp.

Here is the call graph for this function:

void tgCraterShallow::teardown ( )
virtual

Undoes setup. Deletes child models. Called automatically on reset and end of simulation. Notifies controllers of teardown

Reimplemented from tgModel.

Definition at line 112 of file tgCraterShallow.cpp.

Here is the call graph for this function:

std::string tgModel::toString ( std::string  prefix = "") const
virtualinherited

Returns the tag names of this model and its children

Parameters
[in]prefixa string to append to
Returns
the original string with this model and its children's tags appended

Definition at line 152 of file tgModel.cpp.

Here is the caller graph for this function:


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