Inheritance diagram for DtScriptLocationReference:

Public Member Functions
	DtScriptLocationReference (const DtSimulationServices *simServices)

	DtScriptLocationReference (const DtSimulationServices *simServices, const DtRwLocationReference &locRef)

	DtScriptLocationReference (const DtScriptLocationReference &orig)

	DtScriptLocationReference (const DtScriptVrfObject &object)

	DtScriptLocationReference (const DtLocation3D &loc)

DtScriptLocationReference &	operator= (const DtScriptLocationReference &orig)

	~DtScriptLocationReference ()

bool	operator== (const DtScriptLocationReference &orig)

Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()

	DtAsciiSerializable (const DtAsciiSerializable &orig)

virtual	~DtAsciiSerializable ()

virtual std::string	objectTypeC () const

virtual void	init (void *userData)

Private Member Functions
	DtScriptLocationReference ()

const DtSimulationServices *	mySimServices

DtScriptVrfObject	myObject

DtLocation3D	myLocation

DtRwLocationReference::LocationType	myLocationType

bool	isValid () const

virtual int	locationType () const

virtual void	setLocationType (int locType)

virtual luabind::object	object (lua_State *L) const

virtual void	setObject (const DtScriptVrfObject &object)

virtual DtLocation3D	internalLocation () const

virtual DtUUID	internalObject () const

virtual void	setLocation (const DtLocation3D &loc)

virtual DtLocation3D	location () const

virtual bool	isDynamic () const

virtual DtString	serialize () override

virtual void	init (const DtSimulationServices , DtLocalObject owner)

virtual bool	deserialize (const DtString &data) override

virtual DtString	objectType () const override

static DtAsciiSerializable *	creator ()

DT_DLL_vrfLua std::ostream &	operator<< (std::ostream &, const DtScriptLocationReference &)

void	throwIfNotValid () const

Constructor & Destructor Documentation

DtScriptLocationReference::DtScriptLocationReference ( )

private

Hide the default constructor so we always get a vrfObject to use.

DtScriptLocationReference::DtScriptLocationReference ( const DtSimulationServices * simServices )

DtScriptLocationReference::DtScriptLocationReference	(	const DtSimulationServices *	simServices,
		const DtRwLocationReference &	locRef
	)

DtScriptLocationReference::DtScriptLocationReference ( const DtScriptLocationReference & orig )

DtScriptLocationReference::DtScriptLocationReference ( const DtScriptVrfObject & object )

DtScriptLocationReference::DtScriptLocationReference ( const DtLocation3D & loc )

DtScriptLocationReference::~DtScriptLocationReference ( )

Member Function Documentation

DtScriptLocationReference& DtScriptLocationReference::operator= ( const DtScriptLocationReference & orig )

bool DtScriptLocationReference::operator== ( const DtScriptLocationReference & orig )

bool DtScriptLocationReference::isValid ( ) const

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

virtual int DtScriptLocationReference::locationType ( ) const

virtual

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

virtual void DtScriptLocationReference::setLocationType ( int locType )

virtual

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

virtual luabind::object DtScriptLocationReference::object ( lua_State * L ) const

virtual

Returns the referenced object, if in Object mode. Otherwise, returns a nil value.

virtual void DtScriptLocationReference::setObject ( const DtScriptVrfObject & object )

virtual

Changes to Object mode, and sets the reference object.

virtual DtLocation3D DtScriptLocationReference::internalLocation ( ) const

virtual

Directly returns the stored location, regardless of mode.

virtual DtUUID DtScriptLocationReference::internalObject ( ) const

virtual

Directly returns the stored object, regardless of mode.

virtual void DtScriptLocationReference::setLocation ( const DtLocation3D & loc )

virtual

Changes to Absolute mode, and sets the absolute location.

virtual DtLocation3D DtScriptLocationReference::location ( ) const

virtual

Returns: The current location of this reference. If in absolute mode, returns the absolute location. If in object mode, returns the current location of the referenced object.

virtual bool DtScriptLocationReference::isDynamic ( ) const

virtual

Returns: True if the return from location() can be expected to change over time. This is true if object mode, and false in absolute mode.

virtual DtString DtScriptLocationReference::serialize ( )

overridevirtual

Inherited from DtAsciiSerializable. Returns a string serialized version of this class.

Implements DtAsciiSerializable.

virtual void DtScriptLocationReference::init	(	const DtSimulationServices *	,
		DtLocalObject *	owner
	)

virtual

Called after object is constructed, but before deserialize() is called, during deserialization (scenario and script reload). The Lua scenario loader constructs this object, then calls init with the SimManager as the argument; init saves this in mySimManager.

virtual bool DtScriptLocationReference::deserialize ( const DtString & data )

overridevirtual

Inherited from DtAsciiSerializable. Returns true if it could fill its members with the data contained in the string. False otherwise.

Implements DtAsciiSerializable.

virtual DtString DtScriptLocationReference::objectType ( ) const

overridevirtual

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

Implements DtAsciiSerializable.

static DtAsciiSerializable* DtScriptLocationReference::creator ( )

static

Inherited from DtAsciiSerializable. Returns a new object of this type with.

void DtScriptLocationReference::throwIfNotValid ( ) const

protected

Checks validity and throws a runtime error if not valid.

Friends And Related Function Documentation

DT_DLL_vrfLua std::ostream& operator<<	(	std::ostream &	,
		const DtScriptLocationReference &
	)

friend

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

Member Data Documentation

const DtSimulationServices* DtScriptLocationReference::mySimServices

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

DtScriptVrfObject DtScriptLocationReference::myObject

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

DtLocation3D DtScriptLocationReference::myLocation

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

DtRwLocationReference::LocationType DtScriptLocationReference::myLocationType

protected

Script API functions. ////////////////////////////////////.

Returns true if this is a valid system

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfLua/scriptLocationReference.h

Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation