DtEmitterComponentDescriptor Class Reference

Instances of DtEmitterComponentDescriptor are used to specify the parameters for a DtEmitterComponent object. More...

Inheritance diagram for DtEmitterComponentDescriptor:

List of all members.

Public Member Functions
	DtEmitterComponentDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtEmitterComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtEmitterComponentDescriptor (const DtEmitterComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtEmitterComponentDescriptor &	operator= (const DtEmitterComponentDescriptor &orig)
	assignment
virtual	~DtEmitterComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVector	mountLocation () const
	Accessor/mutator for myMountLocation.
virtual void	setMountLocation (const DtVector &location)
	Accessor/mutator for myMountLocation.
virtual bool	targetingCapable () const
	Accessor/mutator for myTargetingCapable.
virtual void	setTargetingCapable (bool onOff)
	Accessor/mutator for myTargetingCapable.
virtual bool	on () const
	Accessor/mutator for myOn.
virtual void	setOn (bool onOff)
	Accessor/mutator for myOn.
virtual DtEmitterSystemEntry &	emitterSystem ()
	Accessor for myEmitterSystemEntry.
virtual const DtEmitterSystemEntry &	emitterSystem () const
	Accessor for myEmitterSystemEntry.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwVector	myMountLocation
	Parameter Name: mount-location Parameter Description: Emitter system offset from entity in meters.
DtRwBoolean	myTargetingCapable
	Parameter Name: targeting-capable Parameter Description: Emitter system will set target to entities specified in “Set Target” messages.
DtRwBoolean	myOn
	Parameter Name: on Parameter Description: Emitter system on at startup.
DtEmitterSystemEntry	myEmitterSystemEntry
	Parameter Name: emitter-system Parameter Description: Emitter sub-system.

---

Detailed Description

Instances of DtEmitterComponentDescriptor are used to specify the parameters for a DtEmitterComponent object.

The emitter component is a sensor component that mounts on an entity and models basic electromagnetic emissions. An entity can have multiple emitter components. Each emitter component can have multiple beams.

---

Constructor & Destructor Documentation

DtEmitterComponentDescriptor::DtEmitterComponentDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtEmitterComponentDescriptor::DtEmitterComponentDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtEmitterComponentDescriptor::DtEmitterComponentDescriptor	(	const DtEmitterComponentDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtEmitterComponentDescriptor::~DtEmitterComponentDescriptor

(

)

[virtual]

destructor

---

Member Function Documentation

DtEmitterComponentDescriptor& DtEmitterComponentDescriptor::operator=

(

const DtEmitterComponentDescriptor &

orig

)

assignment

virtual DtString DtEmitterComponentDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtEmitterComponentDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtEmitterComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtEmitterComponentDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

virtual DtVector DtEmitterComponentDescriptor::mountLocation

(

)

const [virtual]

Accessor/mutator for myMountLocation.

virtual void DtEmitterComponentDescriptor::setMountLocation

(

const DtVector &

location

)

[virtual]

Accessor/mutator for myMountLocation.

virtual bool DtEmitterComponentDescriptor::targetingCapable

(

)

const [virtual]

Accessor/mutator for myTargetingCapable.

virtual void DtEmitterComponentDescriptor::setTargetingCapable

(

bool

onOff

)

[virtual]

Accessor/mutator for myTargetingCapable.

virtual bool DtEmitterComponentDescriptor::on

(

)

const [virtual]

Accessor/mutator for myOn.

virtual void DtEmitterComponentDescriptor::setOn

(

bool

onOff

)

[virtual]

Accessor/mutator for myOn.

virtual DtEmitterSystemEntry& DtEmitterComponentDescriptor::emitterSystem

(

)

[virtual]

Accessor for myEmitterSystemEntry.

virtual const DtEmitterSystemEntry& DtEmitterComponentDescriptor::emitterSystem

(

)

const [virtual]

Accessor for myEmitterSystemEntry.

---

Member Data Documentation

DtRwVector DtEmitterComponentDescriptor::myMountLocation [protected]

Parameter Name: mount-location
Parameter Description: Emitter system offset from entity in meters.

Parameter Default Value: (0. 0. 0.) (x, y, z)
Parameter Units: meters

DtRwBoolean DtEmitterComponentDescriptor::myTargetingCapable [protected]

Parameter Name: targeting-capable
Parameter Description: Emitter system will set target to entities specified in “Set Target” messages.

Parameter Default Value: False

DtRwBoolean DtEmitterComponentDescriptor::myOn [protected]

Parameter Name: on
Parameter Description: Emitter system on at startup.

Parameter Default Value: False

DtEmitterSystemEntry DtEmitterComponentDescriptor::myEmitterSystemEntry [protected]

Parameter Name: emitter-system
Parameter Description: Emitter sub-system.

---

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

• include/vrfobjparam/emtrCmpDesc.h