makVrv::DtWindowObject Class Reference

Base class for a graphical object that exists in a window Implements a parenting system for DtWindowObjects. More...

Inheritance diagram for makVrv::DtWindowObject:

Classes
struct	DtClipBox
	typedef for this objects's clip coords, each window object has a clip box specified, however, only DtWindowSurface()'s can set the clip box limits. More...

Public Types
typedef std::list< DtUniqueID >	ChildList
	typedef list for holding the IDs of the children of this class More...
typedef DtVector2< double >	DtVector2d
	typedef 2D Vector More...
typedef DtMatrix3< double >	Transform
	typedef 3x3 Matrix for holding this object's transform More...

Public Member Functions
	DtWindowObject (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtWindowObject ()
	DTOR. More...
virtual void	setVisible (bool visible)
	Set / Get the window object's visibility in the window. More...
virtual bool	visible ()
virtual DtUniqueID	uniqueId ()
	Returns the unique ID of this object. More...
DtWindowObject *	getParent ()
	Get the parent windowObject. More...
virtual ChildList	childList ()
	Returns the child list. More...
virtual void	addChild (DtUniqueID id)
	Add a child to this objects child list. More...
virtual void	removeChild (DtUniqueID id)
	Remove a child from this objects child list. More...
virtual void	setColor (float r, float g, float b, float a)
	Set / Get the objects's color. More...
virtual void	getColor (float &r, float &g, float &b, float &a)
virtual void	slot_postTick ()
	Slot for DtDe::signal_postTick, using when this object is flashing/blinking. More...
virtual void	needsUpdate ()
	Called when position/rotation/scale are updated A windowObject's parent will also call this method on all of it's children to update it's values. More...
virtual Transform	windowTransform ()
	Get the window transform that is the total transform of this object and all it's parents. More...
virtual DtClipBox	clipBox ()
	Get this object's clip box specifications. More...
virtual void	setParentId (DtUniqueID parentId)
	Get / Set Parent IDs. More...
virtual DtUniqueID	getParentId ()
virtual void	setPosition (double x, double y)
	Set / Get the window position of this object. More...
virtual void	getPosition (double &x, double &y)
virtual void	setScale (double scale)
	Set / Get the scale of the x y components. More...
virtual void	setScale (double x, double y)
virtual void	getScale (double &x, double &y)
virtual void	setRotation (double rotation)
	Set / Get the rotation of the window object around it's set position, (0.0,0.0) if none is set. More...
virtual void	getRotation (double &rotation)
virtual void	setInheritColor (bool inheritColor)
	Set / Get whether this object inherits it's color from it's parent. More...
virtual bool	inheritColor ()
virtual void	setGroup (int id)
	Set / Get the group ID The higher the Z order the "closer" the element will be drawn to the eye point. More...
virtual int	group ()
virtual void	setFlashing (bool flashing, double interval)
	Set / Get this object to flash on and off at the given interval. More...
virtual void	getFlashing (bool &flashing, double &interval)
virtual void	setChannelOverlay (std::string displayName, std::string windowName, std::string channelName)
	Set / Get the channel overlay names By default window objects are placed on the RemoteDisplayWorldOverlay, which is rendered on all channels that have the "showRemoteGraphics" channel keyword. More...
virtual void	getChannelOverlay (std::string &displayName, std::string &windowName, std::string &channelName)

Protected Attributes
DtDe &	myDe
DtUniqueID	myUniqueId
DtUniqueID	myParentId
ChildList	myChildIdList
DtVector2d	myPosition
DtVector2d	myScale
DtVector2d	myWindowScale
double	myRotation
double	myFlashInterval
double	myLastFlashTime
double	myLastSimTime
bool	myVisible
bool	myLastVisibilityFlash
bool	myInheritColor
bool	myFlashing
float	myColorR
float	myColorG
float	myColorB
float	myColorA
Transform	myWindowTransform
DtClipBox	myClipBox
int	myGroup
std::string	myDisplayName
std::string	myWindowName
std::string	myChannelName

Detailed Description

Base class for a graphical object that exists in a window Implements a parenting system for DtWindowObjects.

Member Typedef Documentation

typedef std::list< DtUniqueID > makVrv::DtWindowObject::ChildList

typedef list for holding the IDs of the children of this class

typedef DtVector2<double> makVrv::DtWindowObject::DtVector2d

typedef 2D Vector

typedef DtMatrix3<double> makVrv::DtWindowObject::Transform

typedef 3x3 Matrix for holding this object's transform

Constructor & Destructor Documentation

makVrv::DtWindowObject::DtWindowObject	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWindowObject::~DtWindowObject ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowObject::setVisible ( bool  visible )

virtual

Set / Get the window object's visibility in the window.

Reimplemented in makVrv::DtWindowArc, makVrv::DtOsgWindowArc, makVrv::DtWindowLine, makVrv::DtWindowEllipse, makVrv::DtWindowText, makVrv::DtWindowPolygon, makVrv::DtOsgWindowEllipseGroup, makVrv::DtWindowTriangleFan, makVrv::DtOsgWindowTriangleGroup, makVrv::DtWindowTriangleStrip, and makVrv::DtOsgWindowLineGroup.

virtual bool makVrv::DtWindowObject::visible ( )

virtual

virtual DtUniqueID makVrv::DtWindowObject::uniqueId ( )

virtual

Returns the unique ID of this object.

virtual void makVrv::DtWindowObject::setParentId ( DtUniqueID  parentId )

virtual

Get / Set Parent IDs.

virtual DtUniqueID makVrv::DtWindowObject::getParentId ( )

virtual

DtWindowObject* makVrv::DtWindowObject::getParent

(

)

Get the parent windowObject.

virtual ChildList makVrv::DtWindowObject::childList ( )

virtual

Returns the child list.

virtual void makVrv::DtWindowObject::addChild ( DtUniqueID  id )

virtual

Add a child to this objects child list.

This method also finds the child object, and sets the parentId on the child to myUniqueId. If the channel information on the child does not match this object, setChannelOverlay() is called to update the child's channel

virtual void makVrv::DtWindowObject::removeChild ( DtUniqueID  id )

virtual

Remove a child from this objects child list.

virtual void makVrv::DtWindowObject::setPosition ( double  x, double  y  )

virtual

Set / Get the window position of this object.

virtual void makVrv::DtWindowObject::getPosition ( double &  x, double &  y  )

virtual

virtual void makVrv::DtWindowObject::setScale ( double  scale )

virtual

Set / Get the scale of the x y components.

virtual void makVrv::DtWindowObject::setScale ( double  x, double  y  )

virtual

virtual void makVrv::DtWindowObject::getScale ( double &  x, double &  y  )

virtual

virtual void makVrv::DtWindowObject::setRotation ( double  rotation )

virtual

Set / Get the rotation of the window object around it's set position, (0.0,0.0) if none is set.

virtual void makVrv::DtWindowObject::getRotation ( double &  rotation )

virtual

virtual void makVrv::DtWindowObject::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set / Get the objects's color.

Reimplemented in makVrv::DtWindowArc, makVrv::DtOsgWindowArc, makVrv::DtWindowLine, makVrv::DtWindowEllipse, makVrv::DtWindowText, makVrv::DtWindowPolygon, makVrv::DtWindowTriangleFan, makVrv::DtOsgWindowEllipseGroup, makVrv::DtWindowTriangleStrip, makVrv::DtOsgWindowTriangleGroup, and makVrv::DtOsgWindowLineGroup.

virtual void makVrv::DtWindowObject::getColor ( float &  r, float &  g, float &  b, float &  a  )

virtual

virtual void makVrv::DtWindowObject::setInheritColor ( bool  inheritColor )

virtual

Set / Get whether this object inherits it's color from it's parent.

virtual bool makVrv::DtWindowObject::inheritColor ( )

virtual

virtual void makVrv::DtWindowObject::setGroup ( int  id )

virtual

Set / Get the group ID The higher the Z order the "closer" the element will be drawn to the eye point.

Reimplemented in makVrv::DtWindowLine, makVrv::DtWindowText, makVrv::DtWindowEllipse, makVrv::DtWindowPolygon, makVrv::DtWindowTriangleFan, makVrv::DtOsgWindowEllipseGroup, makVrv::DtWindowTriangleStrip, makVrv::DtOsgWindowTriangleGroup, and makVrv::DtOsgWindowLineGroup.

virtual int makVrv::DtWindowObject::group ( )

virtual

virtual void makVrv::DtWindowObject::setFlashing ( bool  flashing, double  interval  )

virtual

Set / Get this object to flash on and off at the given interval.

virtual void makVrv::DtWindowObject::getFlashing ( bool &  flashing, double &  interval  )

virtual

virtual void makVrv::DtWindowObject::slot_postTick ( )

virtual

Slot for DtDe::signal_postTick, using when this object is flashing/blinking.

virtual void makVrv::DtWindowObject::needsUpdate ( )

virtual

Called when position/rotation/scale are updated A windowObject's parent will also call this method on all of it's children to update it's values.

Reimplemented in makVrv::DtWindowLine, makVrv::DtOsgWindowArc, makVrv::DtWindowText, makVrv::DtWindowEllipse, makVrv::DtWindowPolygon, makVrv::DtWindowTriangleFan, makVrv::DtOsgWindowEllipseGroup, makVrv::DtWindowTriangleStrip, makVrv::DtOsgWindowTriangleGroup, makVrv::DtOsgWindowLineGroup, and makVrv::DtWindowEntityAttachedSurface.

virtual Transform makVrv::DtWindowObject::windowTransform ( )

virtual

Get the window transform that is the total transform of this object and all it's parents.

virtual DtClipBox makVrv::DtWindowObject::clipBox ( )

virtual

Get this object's clip box specifications.

virtual void makVrv::DtWindowObject::setChannelOverlay ( std::string  displayName, std::string  windowName, std::string  channelName  )

virtual

Set / Get the channel overlay names By default window objects are placed on the RemoteDisplayWorldOverlay, which is rendered on all channels that have the "showRemoteGraphics" channel keyword.

If a user wishes to draw a specific window object on a specific channel, use this method. This does not work for remote displays.

Reimplemented in makVrv::DtWindowLine, makVrv::DtWindowText, makVrv::DtWindowEllipse, makVrv::DtWindowPolygon, makVrv::DtWindowTriangleFan, makVrv::DtOsgWindowEllipseGroup, makVrv::DtWindowTriangleStrip, makVrv::DtOsgWindowTriangleGroup, makVrv::DtOsgWindowLineGroup, and makVrv::DtWindowEntityAttachedSurface.

virtual void makVrv::DtWindowObject::getChannelOverlay ( std::string &  displayName, std::string &  windowName, std::string &  channelName  )

virtual

Member Data Documentation

DtDe& makVrv::DtWindowObject::myDe

protected

DtUniqueID makVrv::DtWindowObject::myUniqueId

protected

DtUniqueID makVrv::DtWindowObject::myParentId

protected

ChildList makVrv::DtWindowObject::myChildIdList

protected

DtVector2d makVrv::DtWindowObject::myPosition

protected

DtVector2d makVrv::DtWindowObject::myScale

protected

DtVector2d makVrv::DtWindowObject::myWindowScale

protected

double makVrv::DtWindowObject::myRotation

protected

double makVrv::DtWindowObject::myFlashInterval

protected

double makVrv::DtWindowObject::myLastFlashTime

protected

double makVrv::DtWindowObject::myLastSimTime

protected

bool makVrv::DtWindowObject::myVisible

protected

bool makVrv::DtWindowObject::myLastVisibilityFlash

protected

bool makVrv::DtWindowObject::myInheritColor

protected

bool makVrv::DtWindowObject::myFlashing

protected

float makVrv::DtWindowObject::myColorR

protected

float makVrv::DtWindowObject::myColorG

protected

float makVrv::DtWindowObject::myColorB

protected

float makVrv::DtWindowObject::myColorA

protected

Transform makVrv::DtWindowObject::myWindowTransform

protected

DtClipBox makVrv::DtWindowObject::myClipBox

protected

int makVrv::DtWindowObject::myGroup

protected

std::string makVrv::DtWindowObject::myDisplayName

protected

std::string makVrv::DtWindowObject::myWindowName

protected

std::string makVrv::DtWindowObject::myChannelName

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtWindowObject.h