Dt3DGraphicalObjectStateRecord Class Reference

Dt3DGraphicalObjectStateRecord implements the 3d graphical object state record for the remote graphics API. More...

Inheritance diagram for Dt3DGraphicalObjectStateRecord:

List of all members.

Public Member Functions
	Dt3DGraphicalObjectStateRecord ()
	Constructor.
	Dt3DGraphicalObjectStateRecord (const Dt3DGraphicalObjectStateRecord &orig)
	Copy Constructor.
const Dt3DGraphicalObjectStateRecord &	operator= (const Dt3DGraphicalObjectStateRecord &orig)
	Assignment Operator.
virtual	~Dt3DGraphicalObjectStateRecord ()
	Destructor.
virtual DtEnvironmentalRecord *	clone () const
	Clone.
virtual void	setOffset (const DtVector &pos)
	Set/Get the offset.
virtual const DtVector &	offset () const
virtual void	setColor (int r, int g, int b, int a)
	Set/Get the color.
virtual void	getColor (int &r, int &g, int &b, int &a) const
virtual void	setFillPattern (int pattern)
	Set/Get the fill pattern.
virtual int	fillPattern () const
virtual void	setFlashing (bool yesNo)
	Set/Get flashing.
virtual bool	flashing () const
virtual void	setForceType (DtForceType forceType)
	Set/Get force the object is associated with.
virtual DtForceType	forceType () const
virtual void	setProjected (bool yesNo)
	Set/Get projected.
virtual bool	projected () const
virtual void	setBound2D (bool yesNo)
	Set/Get Bound 2D.
virtual bool	bound2D () const
virtual bool	setNumberOfApplicationIds (int newNumberOfAppIds)
virtual int	numberOfApplicationIds () const
virtual bool	setApplicationId (int index, const DtGlobalObjectDesignator &subID)
virtual bool	getApplicationId (int index, DtGlobalObjectDesignator &subID) const
virtual bool	setNumberOfAttachments (int newNumberOfAppIds)
virtual int	numberOfAttachments () const
virtual bool	setAttachment (int index, const DtAttachmentDescriptor &desc, const DtGlobalObjectDesignator &attachId)
virtual bool	getAttachment (int index, DtAttachmentDescriptor &desc, DtGlobalObjectDesignator &attachId) const
virtual bool	setNumberOfParentOverlays (int newNumberOfParentOverlays)
virtual int	numberOfParentOverlays () const
virtual bool	setParentOverlay (int index, const DtString &name)
virtual bool	getParentOverlay (int index, DtString &name) const
virtual void	setLabel (const DtString &label)
	Set/Get Label.
virtual const DtString &	label () const
virtual void	setUserData (const char *data, int length)
	Set/Get user data.
virtual const char *	userData (int *length=0) const
virtual bool	createNetworkRepresentation ()
	Create the record's network representation.
const DtNet3DGraphicalObjectStateRecord *	objectNetRep () const
	returns the network representation of the environmental record
DtNet3DGraphicalObjectStateRecord *	objectNetRep ()
virtual void	setFromNet (const DtNetEnvironmentalRecord &buffer)
	used by the PDU class to fill in the network representation
virtual int	netRepSize () const
	returns the size of the net representation, in bytes.
Protected Member Functions
virtual bool	resizeNetRep (int newSize)
virtual void *	pointerToApplicationIds () const
virtual void *	pointerToAttachmentList () const
virtual void *	pointerToAttachmentIdList () const
virtual void *	pointerToParentOverlays () const
virtual void *	pointerToLabel () const
virtual void *	pointerToUserData () const
Protected Attributes
DtVector	myOffset
int	myColorR
int	myColorG
int	myColorB
int	myColorA
int	myFillPattern
bool	myFlashing
DtForceType	myForceType
bool	myProjected
bool	myBound2D
DtGlobalObjectDesignatorList	myApplicationIds
DtAttachmentDescriptorList	myAttachments
DtGlobalObjectDesignatorList	myAttachmentIds
DtStringList	myParentOverlays
DtString	myLabel
char *	myUserData
int	myUserDataLength
int	myNetRepSize

---

Detailed Description

Dt3DGraphicalObjectStateRecord implements the 3d graphical object state record for the remote graphics API.

---

Constructor & Destructor Documentation

Dt3DGraphicalObjectStateRecord::Dt3DGraphicalObjectStateRecord

(

)

Constructor.

Dt3DGraphicalObjectStateRecord::Dt3DGraphicalObjectStateRecord

(

const Dt3DGraphicalObjectStateRecord &

orig

)

Copy Constructor.

virtual Dt3DGraphicalObjectStateRecord::~Dt3DGraphicalObjectStateRecord

(

)

[virtual]

Destructor.

---

Member Function Documentation

const Dt3DGraphicalObjectStateRecord& Dt3DGraphicalObjectStateRecord::operator=

(

const Dt3DGraphicalObjectStateRecord &

orig

)

Assignment Operator.

virtual DtEnvironmentalRecord* Dt3DGraphicalObjectStateRecord::clone

(

)

const [virtual]

Clone.

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void Dt3DGraphicalObjectStateRecord::setOffset

(

const DtVector &

pos

)

[virtual]

Set/Get the offset.

virtual const DtVector& Dt3DGraphicalObjectStateRecord::offset

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setColor	(	int	r,
		int	g,
		int	b,
		int	a
	)		[virtual]

Set/Get the color.

virtual void Dt3DGraphicalObjectStateRecord::getColor	(	int &	r,
		int &	g,
		int &	b,
		int &	a
	)		const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setFillPattern

(

int

pattern

)

[virtual]

Set/Get the fill pattern.

virtual int Dt3DGraphicalObjectStateRecord::fillPattern

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setFlashing

(

bool

yesNo

)

[virtual]

Set/Get flashing.

virtual bool Dt3DGraphicalObjectStateRecord::flashing

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setForceType

(

DtForceType

forceType

)

[virtual]

Set/Get force the object is associated with.

virtual DtForceType Dt3DGraphicalObjectStateRecord::forceType

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setProjected

(

bool

yesNo

)

[virtual]

Set/Get projected.

virtual bool Dt3DGraphicalObjectStateRecord::projected

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setBound2D

(

bool

yesNo

)

[virtual]

Set/Get Bound 2D.

virtual bool Dt3DGraphicalObjectStateRecord::bound2D

(

)

const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setNumberOfApplicationIds

(

int

newNumberOfAppIds

)

[virtual]

virtual int Dt3DGraphicalObjectStateRecord::numberOfApplicationIds

(

)

const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setApplicationId	(	int	index,
		const DtGlobalObjectDesignator &	subID
	)		[virtual]

virtual bool Dt3DGraphicalObjectStateRecord::getApplicationId	(	int	index,
		DtGlobalObjectDesignator &	subID
	)		const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setNumberOfAttachments

(

int

newNumberOfAppIds

)

[virtual]

virtual int Dt3DGraphicalObjectStateRecord::numberOfAttachments

(

)

const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setAttachment	(	int	index,
		const DtAttachmentDescriptor &	desc,
		const DtGlobalObjectDesignator &	attachId
	)		[virtual]

virtual bool Dt3DGraphicalObjectStateRecord::getAttachment	(	int	index,
		DtAttachmentDescriptor &	desc,
		DtGlobalObjectDesignator &	attachId
	)		const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setNumberOfParentOverlays

(

int

newNumberOfParentOverlays

)

[virtual]

virtual int Dt3DGraphicalObjectStateRecord::numberOfParentOverlays

(

)

const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::setParentOverlay	(	int	index,
		const DtString &	name
	)		[virtual]

virtual bool Dt3DGraphicalObjectStateRecord::getParentOverlay	(	int	index,
		DtString &	name
	)		const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setLabel

(

const DtString &

label

)

[virtual]

Set/Get Label.

virtual const DtString& Dt3DGraphicalObjectStateRecord::label

(

)

const [virtual]

virtual void Dt3DGraphicalObjectStateRecord::setUserData	(	const char *	data,
		int	length
	)		[virtual]

Set/Get user data.

virtual const char* Dt3DGraphicalObjectStateRecord::userData

(

int *

length = 0

)

const [virtual]

virtual bool Dt3DGraphicalObjectStateRecord::createNetworkRepresentation

(

)

[virtual]

Create the record's network representation.

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

const DtNet3DGraphicalObjectStateRecord* Dt3DGraphicalObjectStateRecord::objectNetRep

(

)

const

returns the network representation of the environmental record

DtNet3DGraphicalObjectStateRecord* Dt3DGraphicalObjectStateRecord::objectNetRep

(

)

virtual void Dt3DGraphicalObjectStateRecord::setFromNet

(

const DtNetEnvironmentalRecord &

buffer

)

[virtual]

used by the PDU class to fill in the network representation

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual int Dt3DGraphicalObjectStateRecord::netRepSize

(

)

const [virtual]

returns the size of the net representation, in bytes.

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual bool Dt3DGraphicalObjectStateRecord::resizeNetRep

(

int

newSize

)

[protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToApplicationIds

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToAttachmentList

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToAttachmentIdList

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToParentOverlays

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToLabel

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

virtual void* Dt3DGraphicalObjectStateRecord::pointerToUserData

(

)

const [protected, virtual]

Reimplemented in Dt3DGraphicalObjectLineStateRecord.

---

Member Data Documentation

DtVector Dt3DGraphicalObjectStateRecord::myOffset [protected]

int Dt3DGraphicalObjectStateRecord::myColorR [protected]

int Dt3DGraphicalObjectStateRecord::myColorG [protected]

int Dt3DGraphicalObjectStateRecord::myColorB [protected]

int Dt3DGraphicalObjectStateRecord::myColorA [protected]

int Dt3DGraphicalObjectStateRecord::myFillPattern [protected]

bool Dt3DGraphicalObjectStateRecord::myFlashing [protected]

DtForceType Dt3DGraphicalObjectStateRecord::myForceType [protected]

bool Dt3DGraphicalObjectStateRecord::myProjected [protected]

bool Dt3DGraphicalObjectStateRecord::myBound2D [protected]

DtGlobalObjectDesignatorList Dt3DGraphicalObjectStateRecord::myApplicationIds [protected]

DtAttachmentDescriptorList Dt3DGraphicalObjectStateRecord::myAttachments [protected]

DtGlobalObjectDesignatorList Dt3DGraphicalObjectStateRecord::myAttachmentIds [protected]

DtStringList Dt3DGraphicalObjectStateRecord::myParentOverlays [protected]

DtString Dt3DGraphicalObjectStateRecord::myLabel [protected]

char* Dt3DGraphicalObjectStateRecord::myUserData [protected]

int Dt3DGraphicalObjectStateRecord::myUserDataLength [protected]

int Dt3DGraphicalObjectStateRecord::myNetRepSize [protected]

---

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

• include/vrfExtObjects/3dGraphicalObjectStateRecord.h