makVrv::DtWindowPolygon Class Reference

A model-like object that draws a 2D polygon on screen. This polygon class inherits from DtWindowObject() which means it can be included in a parent/child relationship with other window objects, including surfaces, lines, text, and ellipses. Vertices for this polygon are relative to a fixed position, this is the position set in the base class. Rotations are also relative to this position. If a position is not set, the default position is (0.0,0.0). If this object is a child of a surface, and that surface has a clip box set, this objects vertices will automatically be clipped in it's update method. If this object is a child of another object, the position set is relative to the parent. createInstance() must be called first for the other methods in this class to work. Note that this polygon does not support concave shapes where a vertex is further into the center of the polygon that the center calculated from all the vertices. The triangles in this polygon each share a vertex with the center of the polygon. A DtTriangleFan fully supports concave shapes.

Inheritance diagram for makVrv::DtWindowPolygon:

Public Member Functions
	DtWindowPolygon (DtDe &de, DtUniqueID id)
virtual	~DtWindowPolygon ()
virtual void	setVertex (int i, double x, double y)
virtual void	setNumVertices (int numVertices)
virtual void	setVisible (bool isVisible)
virtual void	setStipplePattern (unsigned int stipplePattern)
virtual void	setColor (float r, float g, float b, float a)
virtual void	setFill (bool fill)
virtual void	setGroup (int groupId)
virtual void	setChannelOverlay (const std::string &displayName, const std::string &windowName, const std::string &channelName) override
Public Member Functions inherited from makVrv::DtWindowObject
	DtWindowObject (DtDe &de, DtUniqueID id)
virtual	~DtWindowObject ()
virtual bool	visible ()
virtual DtUniqueID	uniqueId ()
virtual DtWindowObject *	getParent ()
virtual ChildList	childList ()
virtual void	addChild (DtUniqueID id)
virtual void	removeChild (DtUniqueID id)
virtual void	getColor (float &r, float &g, float &b, float &a)
virtual void	slot_postTick ()
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 int	group ()
virtual void	setFlashing (bool flashing, double interval)
virtual void	getFlashing (bool &flashing, double &interval)
virtual void	getChannelOverlay (std::string &displayName, std::string &windowName, std::string &channelName)

Protected Member Functions
virtual void	update ()
virtual void	needsUpdate ()

Protected Attributes
DtWindowPolygonInstance *	myInstance
bool	myConnectedToPostUpdate
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::DtWindowPolygon::DtWindowPolygon	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWindowPolygon::~DtWindowPolygon ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowPolygon::setVertex ( int  i, double  x, double  y  )

virtual

Set the ith vertex of the polygon.

virtual void makVrv::DtWindowPolygon::setNumVertices ( int  numVertices )

virtual

Set the number of vertices in the polygon.

virtual void makVrv::DtWindowPolygon::setVisible ( bool  isVisible )

virtual

Set the polygon visible or invisible.

Reimplemented from makVrv::DtWindowObject.

virtual void makVrv::DtWindowPolygon::setStipplePattern ( unsigned int  stipplePattern )

virtual

Set the stipple pattern.

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

virtual

Set the polygon's color.

Reimplemented from makVrv::DtWindowObject.

virtual void makVrv::DtWindowPolygon::setFill ( bool  fill )

virtual

Set the polygon to filled or outlined.

virtual void makVrv::DtWindowPolygon::setGroup ( int  groupId )

virtual

Set this object's group ID for z order. The higher the Z order the "closer" the element will be drawn to the eye point.

Reimplemented from makVrv::DtWindowObject.

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

overridevirtual

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 from makVrv::DtWindowObject.

virtual void makVrv::DtWindowPolygon::update ( )

protectedvirtual

Called on signal_postUpdate; time to update render data.

virtual void makVrv::DtWindowPolygon::needsUpdate ( )

protectedvirtual

Called by all mutators to set up a postUpdate signal if not already connected.

Reimplemented from makVrv::DtWindowObject.

Member Data Documentation

DtWindowPolygonInstance* makVrv::DtWindowPolygon::myInstance

protected

bool makVrv::DtWindowPolygon::myConnectedToPostUpdate

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtWindowPolygon.h