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.

Inheritance diagram for makVrv::DtWindowSurface:

[legend]

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

virtual	~DtWindowSurface ()

virtual void	setClipBox (DtClipBox clipBox)

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

virtual void	setScaleToClipBox (const bool scaleToClipBox)

virtual void	setSurfaceCoordinateExtents (float minU, float minV, float maxU, float maxV)

Public Member Functions inherited from makVrv::DtWindowObject
	DtWindowObject (DtDe &de, DtUniqueID id)

virtual	~DtWindowObject ()

virtual void	setVisible (bool visible)

virtual bool	visible ()

virtual DtUniqueID	uniqueId ()

virtual DtWindowObject *	getParent ()

virtual ChildList	childList ()

virtual void	addChild (DtUniqueID id)

virtual void	removeChild (DtUniqueID id)

virtual void	setColor (float r, float g, float b, float a)

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

virtual void	slot_postTick ()

virtual void	needsUpdate ()

virtual Transform	windowTransform ()

virtual DtClipBox	clipBox ()

virtual void	setParentId (DtUniqueID parentId)

virtual DtUniqueID	getParentId ()

virtual void	setPosition (double x, double y)

virtual void	getPosition (double &x, double &y)

virtual void	setScale (double scale)

virtual void	setScale (double x, double y)

virtual void	getScale (double &x, double &y)

virtual void	setRotation (double rotation)

virtual void	getRotation (double &rotation)

virtual void	setInheritColor (bool inheritColor)

virtual bool	inheritColor ()

virtual void	setGroup (int id)

virtual int	group ()

virtual void	setFlashing (bool flashing, double interval)

virtual void	getFlashing (bool &flashing, double &interval)

virtual void	setChannelOverlay (const std::string &displayName, const std::string &windowName, const std::string &channelName)

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 DtVector2< double >	DtVector2d

typedef DtMatrix3< double >	Transform

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.vrf5-2-branch/include/vrvCore/DtWindowSurface.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation