Class for creating a "surface" inside a channel coordinates. More...

Inheritance diagram for makVrv::DtWindowSurface:

Public Member Functions
	DtWindowSurface (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWindowSurface ()
	DTOR. More...

virtual void	setClipBox (DtClipBox clipBox)
	Set this surface's clip box. More...

virtual void	setClipBox (double bottomLeftX, double bottomLeftY, double topRightX, double topRightY)

virtual void	setScaleToClipBox (const bool scaleToClipBox)
	Setting this flag means that a scale is calculated from the clip coordinates, and that is set as the scale for the surface. More...

virtual void	setSurfaceCoordinateExtents (float minU, float minV, float maxU, float maxV)
	These UV coords allow for a sub coordinate system on the surface. More...

Public Member Functions inherited from makVrv::DtWindowObject
	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
bool	myScaleToClipBox

float	myMinU

float	myMinV

float	myMaxU

float	myMaxV

Protected Attributes inherited from makVrv::DtWindowObject
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

Additional Inherited Members
Public Types inherited from makVrv::DtWindowObject
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...

Detailed Description

Class for creating a "surface" inside a channel coordinates.

Allows clip coordinates to be set, that DtWindowObject()'s can be drawn inside. These clip coordinates are 0.0->1.0 coordinates that are pushed down through all the children. The DtWindowSurface should be the root DtWindowObject. This class does not draw anything.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtWindowSurface::~DtWindowSurface ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowSurface::setClipBox ( DtClipBox clipBox )

virtual

Set this surface's clip box.

Normalised screen coordinates.

virtual void makVrv::DtWindowSurface::setClipBox	(	double	bottomLeftX,
		double	bottomLeftY,
		double	topRightX,
		double	topRightY
	)

virtual

virtual void makVrv::DtWindowSurface::setScaleToClipBox ( const bool scaleToClipBox )

virtual

Setting this flag means that a scale is calculated from the clip coordinates, and that is set as the scale for the surface.

Defaulted to false.

virtual void makVrv::DtWindowSurface::setSurfaceCoordinateExtents	(	float	minU,
		float	minV,
		float	maxU,
		float	maxV
	)

virtual

These UV coords allow for a sub coordinate system on the surface.

Screen is 0.0->1.0, the surface can be from 0.25->0.75 but you may wish to represent the 0.25->0.75 as 0.0->1.0. These values are used to calculate the scale and origin of the surface. Please set the clip box values first. Scale is calculated as follows: scaleX = (topRightX - bottomLeftX) / (maxU - minU); scaleY = (topRightY - bottomLeftY) / (maxV - minV); The origin or position of the surface is calcualted as follows: originX = bottomLeftX - (minU * scaleX); originY = bottomLeftY - (minV * scaleY);

Reimplemented in makVrv::DtWindowEntityAttachedSurface.

Member Data Documentation

bool makVrv::DtWindowSurface::myScaleToClipBox

protected

float makVrv::DtWindowSurface::myMinU

protected

float makVrv::DtWindowSurface::myMinV

protected

float makVrv::DtWindowSurface::myMaxU

protected

float makVrv::DtWindowSurface::myMaxV

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation