VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtSegmentedLineInterface Class Referenceabstract

An interface for a convex polygon drawn using lines.

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

Public Member Functions

 DtSegmentedLineInterface ()
 
virtual ~DtSegmentedLineInterface ()
 
 DtSegmentedLineInterface (const DtSegmentedLineInterface &)=delete
 
DtSegmentedLineInterfaceoperator= (const DtSegmentedLineInterface &)=delete
 
virtual void setEventsEnabled (bool enabled, unsigned long long userData=0)=0
 
virtual bool eventsEnabled () const =0
 
virtual void setVertexCount (unsigned int vertexCount)=0
 
virtual unsigned int vertexCount () const =0
 
virtual unsigned int segmentCount () const =0
 
virtual void set2DPosition (unsigned int vertexIndex, float x1, float y1)=0
 
virtual void get2DPosition (unsigned int vertexIndex, float &x, float &y) const =0
 
virtual void set3DPosition (unsigned int vertexIndex, float x, float y, float z, float w)=0
 
virtual void get3DPosition (unsigned int vertexIndex, float &x, float &y, float &z, float &w) const =0
 
virtual void set3DDirection (unsigned int vertexIndex, float x, float y, float z)=0
 
virtual void get3DDirection (unsigned int vertexIndex, float &x, float &y, float &z) const =0
 
virtual void setDirection2DLength (unsigned int vertexIndex, float length)=0
 
virtual float direction2DLength (unsigned int vertexIndex) const =0
 
virtual void setSegmentColor (unsigned int segment, float r, float g, float b, float a)=0
 
virtual void setPointColor (unsigned int point, float r, float g, float b, float a)=0
 
virtual void setStipplePattern (unsigned int segment, unsigned int pattern)=0
 
virtual void setStipplePattern (unsigned int segment, unsigned int scale, unsigned int pattern)=0
 
virtual void setWidth (unsigned int segment, float w)=0
 
virtual void setEventWidth (float)=0
 
virtual void setGroup (int)=0
 
virtual void setTexture (DtTextureInterface *texture)=0
 
virtual void setZoomFactor (float z)=0
 
virtual void setRotationOffset (float)=0
 

Constructor & Destructor Documentation

makVrv::DtSegmentedLineInterface::DtSegmentedLineInterface ( )

CTOR.

virtual makVrv::DtSegmentedLineInterface::~DtSegmentedLineInterface ( )
virtual

DTOR.

makVrv::DtSegmentedLineInterface::DtSegmentedLineInterface ( const DtSegmentedLineInterface )
delete

copy constructor - not allowed

Member Function Documentation

DtSegmentedLineInterface& makVrv::DtSegmentedLineInterface::operator= ( const DtSegmentedLineInterface )
delete

equals operator - not allowed

virtual void makVrv::DtSegmentedLineInterface::setEventsEnabled ( bool  enabled,
unsigned long long  userData = 0 
)
pure virtual

Set whether the sprite has widget events. Disabling events disconnects all of the DtSegmentedLine signals The user data is set when enabling the events, to change only the user data make multiple calls with enabled=true.

Implemented in makVrv::DtSegmentedLine.

virtual bool makVrv::DtSegmentedLineInterface::eventsEnabled ( ) const
pure virtual

Get whether events are already enabled.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setVertexCount ( unsigned int  vertexCount)
pure virtual

Set the number of vertices, set the number of vertices before setting their parameters (position, color etc). The number of segments will be one less than the number of vertices set, with the count being at least 1 if the vertex count is > 0.

Implemented in makVrv::DtSegmentedLine.

virtual unsigned int makVrv::DtSegmentedLineInterface::vertexCount ( ) const
pure virtual

Get the vertex count. This count will always be one more than the number of segments available. Use segment count to get the number of segments.

Implemented in makVrv::DtSegmentedLine.

virtual unsigned int makVrv::DtSegmentedLineInterface::segmentCount ( ) const
pure virtual

Number of segments available.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::set2DPosition ( unsigned int  vertexIndex,
float  x1,
float  y1 
)
pure virtual

Set the vertex positions.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::get2DPosition ( unsigned int  vertexIndex,
float &  x,
float &  y 
) const
pure virtual

Get the vertex position.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::set3DPosition ( unsigned int  vertexIndex,
float  x,
float  y,
float  z,
float  w 
)
pure virtual

Set one vertex position. NOTE it is much more efficient to update all vertices using setPositions If several change.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::get3DPosition ( unsigned int  vertexIndex,
float &  x,
float &  y,
float &  z,
float &  w 
) const
pure virtual

Get the vertex position.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::set3DDirection ( unsigned int  vertexIndex,
float  x,
float  y,
float  z 
)
pure virtual

Set the normalized direction of the line in world space.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::get3DDirection ( unsigned int  vertexIndex,
float &  x,
float &  y,
float &  z 
) const
pure virtual

Get the normalized direction of the vertex.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setDirection2DLength ( unsigned int  vertexIndex,
float  length 
)
pure virtual

Set the length of the line in 2D space.

Implemented in makVrv::DtSegmentedLine.

virtual float makVrv::DtSegmentedLineInterface::direction2DLength ( unsigned int  vertexIndex) const
pure virtual

Get the length of the line in 2D space.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setSegmentColor ( unsigned int  segment,
float  r,
float  g,
float  b,
float  a 
)
pure virtual

Set the color of the segment (non-blending)

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setPointColor ( unsigned int  point,
float  r,
float  g,
float  b,
float  a 
)
pure virtual

Set the color of the point (bleding)

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setStipplePattern ( unsigned int  segment,
unsigned int  pattern 
)
pure virtual

Set the stipple pattern.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setStipplePattern ( unsigned int  segment,
unsigned int  scale,
unsigned int  pattern 
)
pure virtual

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setWidth ( unsigned int  segment,
float  w 
)
pure virtual

Set the line width.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setEventWidth ( float  )
pure virtual

Sets the width of the event outline segments. To use the outline width as the event width set the event outline width to -1.0f;.

Implemented in makVrv::DtSegmentedLine.

virtual void makVrv::DtSegmentedLineInterface::setGroup ( int  )
pure virtual

The higher the z order the "closer" to the eyepoint this element will be drawn. Use this variable to stack overlay objects in the particular order you want them displayed.

Implemented in makVrv::DtSegmentedLine, and makVrv::DtTexturedLine.

virtual void makVrv::DtSegmentedLineInterface::setTexture ( DtTextureInterface texture)
pure virtual

TextureSets the texture to use with the line.

Implemented in makVrv::DtSegmentedLine, and makVrv::DtTexturedLine.

virtual void makVrv::DtSegmentedLineInterface::setZoomFactor ( float  z)
pure virtual

Sets the factor by which to adjust distance. The zoom factor will be used to determine how to repeat the textured pattern on the line.

Implemented in makVrv::DtSegmentedLine, and makVrv::DtTexturedLine.

virtual void makVrv::DtSegmentedLineInterface::setRotationOffset ( float  )
pure virtual

Sets the offset to the rotation to apply to the segmented line. Use for observer rotation.

Implemented in makVrv::DtSegmentedLine, and makVrv::DtTexturedLine.


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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)