VR-Forces 4.0.4 Class Documentation
Public Member Functions
DtEditorExtensionInterface Class Reference

This shell class will be passed into the opd editor plugin to add in new components. More...

List of all members.

Public Member Functions

 DtEditorExtensionInterface ()
virtual ~DtEditorExtensionInterface ()
virtual void addController (const char *controllerName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)=0
 Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
virtual void addSensor (const char *sensorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)=0
virtual void addActuator (const char *actuatorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)=0
virtual void addParameterType (const char *parameter, const char *parameterLike, DtSimObjectParametersCreatorFcn fcn)=0
 The parameterLike value is the parameter this parameter type most closely matches of the exising parameter types (i.e.
virtual void addUiElement (const char *elementContextBlock, const char *parameter, const char *placeNear, bool after=true)=0
 Used only for the entity editor, adds the ui element after (or before) the specified readerWriterItem.
virtual DtTMApplicationapp ()=0
 Returns a pointer to the application object.

Detailed Description

This shell class will be passed into the opd editor plugin to add in new components.


Constructor & Destructor Documentation


Member Function Documentation

virtual void DtEditorExtensionInterface::addController ( const char *  controllerName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
) [pure virtual]

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtEditorExtensionInterface::addSensor ( const char *  sensorName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
) [pure virtual]
virtual void DtEditorExtensionInterface::addActuator ( const char *  actuatorName,
const char *  descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
) [pure virtual]
virtual void DtEditorExtensionInterface::addParameterType ( const char *  parameter,
const char *  parameterLike,
DtSimObjectParametersCreatorFcn  fcn 
) [pure virtual]

The parameterLike value is the parameter this parameter type most closely matches of the exising parameter types (i.e.

"ground-vehicle-param")

virtual void DtEditorExtensionInterface::addUiElement ( const char *  elementContextBlock,
const char *  parameter,
const char *  placeNear,
bool  after = true 
) [pure virtual]

Used only for the entity editor, adds the ui element after (or before) the specified readerWriterItem.

Note the context block is as if it were put into the entityEditorUi.mtl file. For example:

(item-component (reader-writer-name "embarkation-controller") (component-type "embarkation-controller") (parameter-type "embarkation-descriptor") (category "controllers") (title "Can Embark") (automatically-add False) (tool-tip "Allow entity to embark onto other entities.") )

The parameter is the parameter block to put this context block into. If NULL (or empty string), puts it into all blocks. The paremeter block can also be a semi-colon list to place it into multiple blocks

virtual DtTMApplication* DtEditorExtensionInterface::app ( ) [pure virtual]

Returns a pointer to the application object.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)