 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtSimCommand subclass for creating a new VrfObjects. More...
Public Member Functions | |
| DtCreateObjectCommand () | |
| Default constructor. | |
| DtCreateObjectCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Usual constructor. | |
| DtCreateObjectCommand (const DtString &writeName, const DtCreateObjectCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtCreateObjectCommand () |
| destructor | |
| DtCreateObjectCommand & | operator= (const DtCreateObjectCommand &orig) |
| assignment operator | |
| int | type () const |
| virtual DtSimCommand * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| virtual void | clearVertices () |
| Clears out all vertices. | |
| virtual void | addVertex (const DtVector &vertex) |
| Adds the specified vertex to the end of the vertex list. | |
| virtual int | numberOfVertices () const |
| Returns the number of vertices in the vertex list. | |
| virtual DtVector | vertex (unsigned int index) const |
| Returns the vertex at the specified index into the vertex list. | |
| virtual bool | headingSpecified () const |
| virtual DtString | stringRep () const |
| Text representation of this command. | |
| virtual int | netRepSize () const |
| Returns the size in bytes of the network representation of the class. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand). | |
| virtual bool | setToNet () |
| Calls netRep() to create the network buffer. | |
| virtual const std::list < DtAdminContent * > & | initialAdminContent () const |
| Set any Admin Content messages passed on initialization. | |
| virtual void | setInitialAdminContent (std::list< DtAdminContent * > adminContent) |
| virtual void | addInitialAdminContent (const DtAdminContent *adminContent) |
| virtual const std::list < DtSimInterfaceContent * > & | initialInterfaceContent () const |
| Set any Interface Content messages passed on initialization. | |
| virtual void | setInitialInterfaceContent (std::list< DtSimInterfaceContent * > adminContent) |
| virtual void | addInitialInterfaceContent (const DtSimInterfaceContent *adminContent) |
| virtual void | createAndAddAdminContentFromEncodedBuffer (const DtString &) |
| Recreates admin content from the encoded buffer and adds it to the list. | |
| virtual void | encodeAndAddAdminContent (const DtAdminContent *) |
| Encodes admin content and adds to admin contents. | |
| virtual void | createAndAddInterfaceContentFromEncodedBuffer (const DtString &) |
| Recreates interface content from the encoded buffer and adds it to the list. | |
| virtual void | encodeAndAddInterfaceContent (const DtSimInterfaceContent *) |
| Encodes admin content and adds to interface contents. | |
| virtual DtString | objectName () const |
| Name of the object to create. | |
| virtual void | setObjectName (const DtString &name) |
| Name of the object to create. | |
| virtual DtObjectType | objectType () const |
| Type of object to create. | |
| virtual void | setObjectType (const DtObjectType &objectType) |
| Type of object to create. | |
| virtual DtForceType | forceType () const |
| Force of the object to create. | |
| virtual void | setForceType (const DtForceType &force) |
| Force of the object to create. | |
| virtual DtReal | heading () const |
| Heading of object to create. | |
| virtual void | setHeading (DtReal heading) |
| Heading of object to create. | |
| virtual bool | closedFigure () const |
| Indicated whether the object is a closed figure. | |
| virtual void | setClosedFigure (bool closed) |
| Indicated whether the object is a closed figure. | |
| virtual bool | projected () const |
| Indicated whether the object projected onto the terrain in the Z direction. | |
| virtual void | setProjected (bool value) |
| Indicated whether the object projected onto the terrain in the Z direction. | |
| virtual bool | clampedToGround () const |
| Indicated whether the object is clamped to terrain Applies only to entities. | |
| virtual void | setClampedToGround (bool value) |
| Indicated whether the object is clamped to terrain Applies only to entities. | |
| virtual bool | aggregated () const |
| Indicated whether the object is aggregated Is only meaningful with respect to aggregates. | |
| virtual void | setAggregated (bool value) |
| Indicated whether the object is aggregated Is only meaningful with respect to aggregates. | |
Static Public Member Functions | |
| static DtSimCommand * | creator () |
| Returns a new instance of this class. | |
Protected Member Functions | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| virtual char * | decodeBuffer (const DtString &) const |
| virtual DtString | encodeBuffer (const char *chr, int length) const |
Protected Attributes | |
| DtRwString | myObjectName |
| DtRwObjectType | myObjectType |
| DtRwForceType | myForceType |
| DtRwTemplatedListPtr< DtRwVector > | myVertices |
| DtRwReal | myHeading |
| DtRwBoolean | myClosedFigure |
| DtRwBoolean | myProjected |
| DtRwBoolean | myClampedToGround |
| DtRwBoolean | myAggregated |
| DtRwStringList | myAdminContents |
| DtRwStringList | myInterfaceContents |
| std::list< DtAdminContent * > | myAdditionalAdminContent |
| Local only. DtRwStringList keeps the string rep of all the commands. | |
| std::list < DtSimInterfaceContent * > | myAdditionalInterfaceContent |
| Local only. DtRwStringList keeps the string rep of all the commands. | |
DtSimCommand subclass for creating a new VrfObjects.
Used for both single and multi-point objects. Single point objects should specify just one vertex in the vertex list.
Default constructor.
| DtCreateObjectCommand::DtCreateObjectCommand | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Usual constructor.
| DtCreateObjectCommand::DtCreateObjectCommand | ( | const DtString & | writeName, |
| const DtCreateObjectCommand & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
| virtual DtCreateObjectCommand::~DtCreateObjectCommand | ( | ) | [virtual] |
destructor
| DtCreateObjectCommand& DtCreateObjectCommand::operator= | ( | const DtCreateObjectCommand & | orig | ) |
assignment operator
| int DtCreateObjectCommand::type | ( | ) | const [virtual] |
Implements DtSimCommand.
| virtual DtSimCommand* DtCreateObjectCommand::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Implements DtSimCommand.
| virtual DtString DtCreateObjectCommand::objectName | ( | ) | const [virtual] |
Name of the object to create.
The name is optional. If no name (or a NULL name) is specified, the system will auto-generate a name for the object.
| virtual void DtCreateObjectCommand::setObjectName | ( | const DtString & | name | ) | [virtual] |
Name of the object to create.
The name is optional. If no name (or a NULL name) is specified, the system will auto-generate a name for the object.
| virtual DtObjectType DtCreateObjectCommand::objectType | ( | ) | const [virtual] |
Type of object to create.
| virtual void DtCreateObjectCommand::setObjectType | ( | const DtObjectType & | objectType | ) | [virtual] |
Type of object to create.
| virtual DtForceType DtCreateObjectCommand::forceType | ( | ) | const [virtual] |
Force of the object to create.
| virtual void DtCreateObjectCommand::setForceType | ( | const DtForceType & | force | ) | [virtual] |
Force of the object to create.
| virtual void DtCreateObjectCommand::clearVertices | ( | ) | [virtual] |
Clears out all vertices.
| virtual void DtCreateObjectCommand::addVertex | ( | const DtVector & | vertex | ) | [virtual] |
Adds the specified vertex to the end of the vertex list.
Vertices are specified in geocentric.
| virtual int DtCreateObjectCommand::numberOfVertices | ( | ) | const [virtual] |
Returns the number of vertices in the vertex list.
| virtual DtVector DtCreateObjectCommand::vertex | ( | unsigned int | index | ) | const [virtual] |
Returns the vertex at the specified index into the vertex list.
| DtException | if outside current vertex range (0 to numberOfVertices - 1) Vertices are specified in geocentric. |
| virtual DtReal DtCreateObjectCommand::heading | ( | ) | const [virtual] |
Heading of object to create.
Only applicable to single-point objects. 0 is north, clockwise, in radians.
| virtual void DtCreateObjectCommand::setHeading | ( | DtReal | heading | ) | [virtual] |
Heading of object to create.
Only applicable to single-point objects. 0 is north, clockwise, in radians.
| virtual bool DtCreateObjectCommand::headingSpecified | ( | ) | const [virtual] |
| virtual bool DtCreateObjectCommand::closedFigure | ( | ) | const [virtual] |
Indicated whether the object is a closed figure.
Applies only to multi-point objects.
| virtual void DtCreateObjectCommand::setClosedFigure | ( | bool | closed | ) | [virtual] |
Indicated whether the object is a closed figure.
Applies only to multi-point objects.
| virtual bool DtCreateObjectCommand::projected | ( | ) | const [virtual] |
Indicated whether the object projected onto the terrain in the Z direction.
Applies only to control/overlay objects.
| virtual void DtCreateObjectCommand::setProjected | ( | bool | value | ) | [virtual] |
Indicated whether the object projected onto the terrain in the Z direction.
Applies only to control/overlay objects.
| virtual bool DtCreateObjectCommand::clampedToGround | ( | ) | const [virtual] |
Indicated whether the object is clamped to terrain Applies only to entities.
| virtual void DtCreateObjectCommand::setClampedToGround | ( | bool | value | ) | [virtual] |
Indicated whether the object is clamped to terrain Applies only to entities.
| virtual bool DtCreateObjectCommand::aggregated | ( | ) | const [virtual] |
Indicated whether the object is aggregated Is only meaningful with respect to aggregates.
| virtual void DtCreateObjectCommand::setAggregated | ( | bool | value | ) | [virtual] |
Indicated whether the object is aggregated Is only meaningful with respect to aggregates.
| virtual DtString DtCreateObjectCommand::stringRep | ( | ) | const [virtual] |
Text representation of this command.
Implements DtSimCommand.
| virtual int DtCreateObjectCommand::netRepSize | ( | ) | const [virtual] |
Returns the size in bytes of the network representation of the class.
This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).
Reimplemented from DtSimCommand.
| virtual bool DtCreateObjectCommand::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().
Reimplemented from DtSimCommand.
| virtual bool DtCreateObjectCommand::setToNet | ( | ) | [virtual] |
Calls netRep() to create the network buffer.
Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().
Reimplemented from DtSimCommand.
| virtual const std::list<DtAdminContent*>& DtCreateObjectCommand::initialAdminContent | ( | ) | const [virtual] |
Set any Admin Content messages passed on initialization.
| virtual void DtCreateObjectCommand::setInitialAdminContent | ( | std::list< DtAdminContent * > | adminContent | ) | [virtual] |
| virtual void DtCreateObjectCommand::addInitialAdminContent | ( | const DtAdminContent * | adminContent | ) | [virtual] |
| virtual const std::list<DtSimInterfaceContent*>& DtCreateObjectCommand::initialInterfaceContent | ( | ) | const [virtual] |
Set any Interface Content messages passed on initialization.
| virtual void DtCreateObjectCommand::setInitialInterfaceContent | ( | std::list< DtSimInterfaceContent * > | adminContent | ) | [virtual] |
| virtual void DtCreateObjectCommand::addInitialInterfaceContent | ( | const DtSimInterfaceContent * | adminContent | ) | [virtual] |
| virtual void DtCreateObjectCommand::createAndAddAdminContentFromEncodedBuffer | ( | const DtString & | ) | [virtual] |
Recreates admin content from the encoded buffer and adds it to the list.
| virtual void DtCreateObjectCommand::encodeAndAddAdminContent | ( | const DtAdminContent * | ) | [virtual] |
Encodes admin content and adds to admin contents.
| virtual void DtCreateObjectCommand::createAndAddInterfaceContentFromEncodedBuffer | ( | const DtString & | ) | [virtual] |
Recreates interface content from the encoded buffer and adds it to the list.
| virtual void DtCreateObjectCommand::encodeAndAddInterfaceContent | ( | const DtSimInterfaceContent * | ) | [virtual] |
Encodes admin content and adds to interface contents.
| static DtSimCommand* DtCreateObjectCommand::creator | ( | ) | [static] |
Returns a new instance of this class.
| virtual void DtCreateObjectCommand::getSelf | ( | DtlObjPtr | args, |
| const DtFilename & | searchPath, | ||
| const DtVariableBindingsList & | variableBindings | ||
| ) | [protected, virtual] |
| virtual char* DtCreateObjectCommand::decodeBuffer | ( | const DtString & | ) | const [protected, virtual] |
| virtual DtString DtCreateObjectCommand::encodeBuffer | ( | const char * | chr, |
| int | length | ||
| ) | const [protected, virtual] |
DtRwString DtCreateObjectCommand::myObjectName [protected] |
DtRwObjectType DtCreateObjectCommand::myObjectType [protected] |
DtRwForceType DtCreateObjectCommand::myForceType [protected] |
DtRwReal DtCreateObjectCommand::myHeading [protected] |
DtRwBoolean DtCreateObjectCommand::myClosedFigure [protected] |
DtRwBoolean DtCreateObjectCommand::myProjected [protected] |
DtRwBoolean DtCreateObjectCommand::myClampedToGround [protected] |
DtRwBoolean DtCreateObjectCommand::myAggregated [protected] |
DtRwStringList DtCreateObjectCommand::myAdminContents [protected] |
std::list<DtAdminContent*> DtCreateObjectCommand::myAdditionalAdminContent [protected] |
Local only. DtRwStringList keeps the string rep of all the commands.
std::list<DtSimInterfaceContent*> DtCreateObjectCommand::myAdditionalInterfaceContent [protected] |
Local only. DtRwStringList keeps the string rep of all the commands.