VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtWindowSurface Class Reference

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

Inheritance diagram for makVrv::DtWindowSurface:
Inheritance graph
[legend]

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...
 
- 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...
 
DtWindowObjectgetParent ()
 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 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 DtVector2d windowScale ()
 Get the window scale of the object. 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 ()
 

Protected Attributes

bool myScaleToClipBox
 
- Protected Attributes inherited from makVrv::DtWindowObject
DtDemyDe
 
DtUniqueID myUniqueId
 
DtUniqueID myParentId
 
ChildList myChildIdList
 
DtVector2d myPosition
 
DtVector2d myScale
 
DtVector2d myWindowScale
 
double myRotation
 
bool myVisible
 
bool myInheritColor
 
float myColorR
 
float myColorG
 
float myColorB
 
float myColorA
 
Transform myRelativeTransform
 
Transform myWindowTransform
 
DtClipBox myClipBox
 

Additional Inherited Members

- Public Types inherited from makVrv::DtWindowObject
typedef std::list< DtUniqueIDChildList
 typedef list for holding the IDs of the children of this class More...
 
typedef DtVector2< doubleDtVector2d
 typedef 2D Vector More...
 
typedef DtMatrix3< doubleTransform
 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.

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.

Member Data Documentation

bool makVrv::DtWindowSurface::myScaleToClipBox
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)