#include <gls_poly_line.h>

Inheritance diagram for GlsPolyLine:

Public Member Functions
	GlsPolyLine ()

virtual	~GlsPolyLine ()

virtual DisplayObject *	CloneObject (bool generateNames=false)

virtual void	GetExtents (float &minx, float &miny, float &minz, float &maxx, float &maxy, float &maxz)

virtual void	SetColor (const GlsColor &color)

virtual void	SetFillColor (const GlsColor &color)

virtual void	CopyProperties (DisplayObject *src)

virtual void	CopyGeometry (DisplayObject *srcArg)

virtual InterfaceListType *	GetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)

virtual void	GetCppInterfaceDescriptionFree (InterfaceListType *array)

virtual void	PreDraw (const OpenGLMatrices &parentMatrices, Culler &culler)

virtual void	Draw (void)

virtual void	Scale (float px, float py, float pz, Vertex *anchor, int handleBar)

virtual void	Rotate (const Vector &orig, float angle, const Vector &axis)

virtual bool	Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)

virtual void	SetValue (int spec, va_list &args)

virtual void	SetAvailableAttributes (unsigned int value)

virtual void	PolygonEnd (const int end)

void	Thickness (const float &val)

float	Thickness (void)

Vector	GlobalNormal (void)

void	Halo (const bool &val)

bool	Halo (void)

void	HaloColor (const GlsColor &val)

GlsColor	HaloColor (void)

void	HaloThickness (const float &val)

float	HaloThickness (void)

virtual void	SetVertices (unsigned int nPoints, Vertex *vertices)

void	DeleteVertexAt (unsigned int index) DISTI_METHOD_OVERRIDE

virtual void	SetRecalculate (void)

Public Member Functions inherited from GLPolygon
	GLPolygon (unsigned int nPoints, const Vertex *vertices)

	GLPolygon (unsigned int nPoints, const Vertex *vertices, const Vertex &location)

	GLPolygon (void)

	GLPolygon (const GLPolygon &polygon, const bool generateNames)

virtual	~GLPolygon (void)

void	ConfigureMetaData (void)

virtual void	CalculateTextureCoordinates (void)

virtual void	CalcNormals (int windingOrder=1)

virtual DisplayObject *	Pick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &parentDrawn)

Public Member Functions inherited from DisplayObject
	DisplayObject (float x, float y, float z)

	DisplayObject (const DisplayObject &object, const bool generateNames)

virtual	~DisplayObject (void)

void	Destroy ()

virtual void	AlphaMode (int mode)

virtual int	AlphaMode (void)

virtual bool	AntiAlias (void)

virtual void	AntiAlias (bool alias)

void	ApplyTextureSettings (int textureIndex=-1)

DistiAttribDict &	Attributes ()

virtual void	SetBlendColor (const GlsColor &color)

void	GetBlendColor (unsigned char color[])

void	GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)

virtual GlsColor	GetBlendColor ()

void	SetBlendColor (unsigned char color[])

void	SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

bool	BlinkedOff (void)

virtual bool	Blinking (void)

virtual void	Blinking (const bool blink)

virtual float	BlinkRate (void)

virtual void	BlinkRate (const float rate)

const Vector &	BoundingVolumeCenter () const

void	BoundingVolumeCenter (const Vector &center)

bool	BoundingVolumeHit (const Vector &start, const Vector &direction)

float	BoundingVolumeRadius () const

void	BoundingVolumeRadius (float radius)

virtual void	Calculate (double time)

void	CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)

virtual void	CalculateParentBoundingBox (void)

bool	GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)

CallbackMethodCallerBase *	CallbackCaller () const

void	CallbackCaller (CallbackMethodCallerBase *cb)

virtual void	GetCenter (Vector &center)

virtual GlsColor	GetColor ()

void	GetColor (unsigned char c4[])

void	GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)

void	SetColor (unsigned char c4[])

void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

virtual void	CopyHierarchyProperties (DisplayObject *src, bool copyName)

virtual void	CullBackFace (const bool val)

virtual bool	CullBackFace (void)

bool	Culled () const

bool	CullTest (const GlsMatrixType *matrix, const Culler &culler)

GlsMatrixType &	DcsMatrix ()

void	DcsMatrix (const GlsMatrixType &matrix)

virtual void	DeleteVertex (unsigned int indexAfter) final

virtual int	DepthTest (void)

virtual void	DepthTest (unsigned char zbuf)

const GlsMatrixType *	DrawMatrix ()

bool	NeedCalcDrawMatrix ()

void	DynamicRotate (float angle, int axis)

void	DynamicRotate (const Vector &v)

void	DynamicRotate (float angle[])

virtual void	DynamicRotate (float x, float y, float z)

virtual void	DynamicRotateRelative (float angle, int axis)

virtual float	DynamicRotation (int axis)

virtual Vector	DynamicScale ()

virtual void	DynamicScale (float x, float y, float z)

void	DynamicScale (const Vector &scale)

virtual void	DynamicTranslate (float x, float y, float z, bool relative=false)

void	DynamicTranslate (const Vertex &amount, bool relative)

void	DynamicTranslate (const Vector &amount)

virtual void	DynamicTranslate (float amount, int axis, bool relative=false)

virtual float	DynamicTranslation (int axis)

virtual Vector	DynamicTranslation ()

DisplayObjectEditor *	Editor ()

const DisplayObjectEditor *	Editor () const

void	Editor (DisplayObjectEditor *editor)

void	GetExtentsDCS (Vector &min, Vector &max)

void	GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)

void	GetFillColor (unsigned char c4[])

virtual GlsColor	GetFillColor (void)

void	SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)

void	SetFillColor (unsigned char c4[])

virtual void	GenerateInstanceName (void)

virtual DisplayObject *	handle (DisplayEvent *ev)

virtual bool	HitUtil (float x, float y, float z, float scale, Vertex vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector collisionPoint)

virtual void	InsertVertexAt (unsigned int index)

virtual void	InsertVertex (unsigned int indexAfter) final

char *	InstanceName (void)

void	InstanceName (const char *name)

virtual bool	LightingEnabled ()

virtual void	LightingEnabled (bool lighting)

virtual int	LineStippleMultiplier (void)

virtual void	LineStippleMultiplier (int mult)

virtual int	LineStipplePattern (void)

virtual void	LineStipplePattern (int pattern)

virtual float	LineWidth (void)

virtual void	LineWidth (float width)

virtual const Vertex &	Location (void) const

virtual void	Location (const Vertex &v)

virtual void	Location (float x, float y, float z)

virtual void	GetLocation (Vertex &v)

virtual void	GetLocation (float &x, float &y, float &z)

float	X (void) const

float	Y (void) const

float	Z (void) const

void	X (const float x)

void	Y (const float y)

void	Z (const float z)

virtual int	MaterialIndex ()

virtual void	MaterialIndex (int index)

virtual DynamicArray< int > &	MaterialIndices ()

virtual void	MaterialIndices (DynamicArray< int > indices)

GlsMatrixType *	ModelMatrix ()

bool	NeedCalculate ()

Vector *	Normals ()

virtual void	SetNormals (unsigned int nPoints, Vector *vertices)

void	VaSetNormals (unsigned int nPoints,...)

unsigned int	NumberOfVertices () const

virtual float	ObjectDepth (void)

virtual float	ObjectHeight (void)

virtual float	ObjectWidth (void)

virtual void	SetOrigin (const Vertex &vert)

virtual void	Parent (DisplayFrame *par)

DisplayFrame *	Parent (void) const

virtual void	ParentGroup (Group *group)

Group *	ParentGroup (void) const

unsigned char	Pickable ()

virtual void	Pickable (unsigned char pick)

virtual int	PolygonEnd (void)

virtual int	PolygonMode (void)

virtual void	PolygonMode (int mode)

GlsMatrixType *	ProjMatrix ()

virtual void	ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)

virtual float	RelativeAngle (const float x, const float y)

virtual DistiAttributeBase &	Resource (const char *name)

virtual void	GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)

void	RestoreAlpha (void)

void	RestoreAntiAlias (void)

void	RestoreLighting (void)

void	RestoreLineStyle (void)

const Vertex &	RotationPoint () const

virtual void	RotationPoint (const Vertex &v)

virtual void	RotationPoint (float x, float y, float z)

virtual void	GetRotationPoint (Vertex &v)

virtual void	Rotate (float angle, int axis=Z_AXIS)

virtual void	Rotate (const Vector &origin, float angle, int axis=Z_AXIS)

void	SaveMatrices ()

void	Set (int spec,...)

bool	SetupAlpha (void)

bool	SetupAntiAlias (void)

void	SetupDepthTest (void)

void	SetupLighting (void)

bool	SetupLineStyle (void)

void	SetupPolyDrawStyle (void)

void	SetupShading (void)

bool	SetupTexture (void)

virtual int	Shading (void)

virtual void	Shading (const int shading)

virtual void	GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)

virtual void	SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)

void	SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)

void	VaSetTexCoords (unsigned int nPoints,...)

Vector *	TextureCoordinates (void)

Vector *	GetTextureCoordinates (void)

virtual int	TextureIndex (void)

virtual void	TextureIndex (int textureIndex)

virtual Vector *	GetTexturePoints (void)

virtual bool	TextureRepeat (void)

virtual void	TextureRepeat (const int rep)

virtual int	TextureMappingTechnique (void)

virtual void	TextureMappingTechnique (const int map)

virtual int	TextureMagnificationFilter (void)

virtual void	TextureMagnificationFilter (const int filter)

virtual int	TextureMinificationFilter (void)

virtual void	TextureMinificationFilter (const int filter)

virtual void	Translate (float tr[])

virtual void	Translate (float x, float y, float z)

virtual void	TranslateVertices (float x, float y, float z)

virtual void	UpdateBoundingVolume (void)

void *	UserData (void) const

void	UserData (void *data)

virtual void	SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])

virtual Vertex *	Vertices ()

void	VaSetVertices (unsigned int nPoints,...)

int *	ViewMatrix ()

bool	Visible (void) const

bool	Visibility (void) const

virtual void	Visibility (const bool vis)

virtual Vector	WorldRotationPoint (void)

virtual void	WorldRotationPoint (const Vector &vert)

virtual Vertex	WorldVertex (unsigned int i)

virtual void	WorldVertex (unsigned int i, const Vertex &vert)

bool	LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())

bool	WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())

void	LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType dcsMatrix=NULL)

void	DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)

virtual bool	GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)

void	NotifyAttributeChanged (const AttributeName &name) override

virtual void	SetPainter (GlsPainter *painter)

virtual GlsPainter *	GetPainter ()

void	InvalidatePainter ()

virtual bool	IsVisibleInScene (const DisplayObject *obj=NULL) const

Public Member Functions inherited from AttributeChangedNotifier
virtual	~AttributeChangedNotifier ()

Public Member Functions inherited from WeakReferenceableMixin
void	AddWeakReference (WeakReference *weakRef) override

void	NotifyWeakReferenceDestroyed (WeakReference *ref) override

Protected Member Functions
void	UpdateHaloEndCaps ()

void	VerticesChanged (void)

void	ComputeSegments (void)

void	ComputeSegments (GlsPolyLineTriangleList &array, float thickness, bool calculatingHalos=false)

void	ComputeCorner (GlsPolyLineTriangleList &array, float thickness, float cornerRadius, const Vector &refVert, const Vector &v1, const Vector &v2, const Vector &v3, const Vector &v4, const Vector &l1, const Vector &l2, bool calculatingHalos=false)

Protected Member Functions inherited from DisplayObject
virtual void	VaListSetVertices (unsigned int nPoints, va_list args)

virtual void	VaListSetNormals (unsigned int nPoints, va_list args)

virtual void	VaListSetTexCoords (unsigned int nPoints, va_list args)

void	AllocateModelMatrix ()

bool	ApplyDynamicRotation (void)

virtual void	CalcDrawMatrix ()

void	CalcDrawMatrixIfExists ()

virtual void	CalculateMatrices (const OpenGLMatrices &newMatrices)

bool	InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)

void	NeedCalculate (bool val)

void	PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)

void	PickCleanup (Vertex *vertices, unsigned int vertex_cnt)

int	GetApplicableTextureIndex ()

int	GetApplicableTextureRepeat ()

Protected Member Functions inherited from WeakReferenceableMixin
	WeakReferenceableMixin (void)

virtual	~WeakReferenceableMixin ()

Additional Inherited Members
Public Types inherited from DisplayObject
enum	AvailableAttributesEnum

Static Public Member Functions inherited from DisplayObject
static void	UseManualBlinkElapsedTime (bool useManualTime)

static void	SetManualBlinkElapsedTime (double elapsedTime)

Protected Attributes inherited from DisplayObject
int	_alphaMode

bool	_antiAlias

bool	_attributesAdded

bool	_blinking

float	_blinkRate

GlsColor	_color

bool	_cullBackFace

GlsMatrixType	_dcsMatrix

unsigned char	_depthTest

GlsMatrixType *	_drawMatrix

unsigned char	_lineStippleMultiplier

unsigned short	_lineStipplePattern

float	_lineWidth

Vertex	_location

GlsMatrixType *	_modelMatrix

Vector *	_normals

unsigned int	_nTex_vertices

unsigned int	_nVertices

unsigned char	_polygonEnd

unsigned char	_polygonMode

int	_polygonOffset

GlsMatrixType *	_projMatrix

unsigned char	_shading

Vector *	_texCoord

GlsColor	_textureBlendColor

int	_textureIndex

unsigned char	_textureMagFilter

unsigned char	_textureMinFilter

unsigned char	_textureMap

Vector	_texturePoints [4]

unsigned char	_textureRepeat

void *	_userData

Vertex *	_vertices

int *	_viewMatrix

bool	_visible

Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > *	_weakRefs

Detailed Description

Runtime implementation of a GlsPolyLine

Constructor & Destructor Documentation

GlsPolyLine ( )

Create a new GlsPolyLine.

virtual ~GlsPolyLine ( )

virtual

Destructs a GlsPolyLine object

Member Function Documentation

virtual DisplayObject* CloneObject ( bool generateNames = false )

virtual

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

Parameters

generateNames Whether or not to generate new names for cloned objects

Returns: A new object, identical to the original, except for the instance name

Reimplemented from GLPolygon.

void ComputeCorner	(	GlsPolyLineTriangleList &	array,
		float	thickness,
		float	cornerRadius,
		const Vector &	refVert,
		const Vector &	v1,
		const Vector &	v2,
		const Vector &	v3,
		const Vector &	v4,
		const Vector &	l1,
		const Vector &	l2,
		bool	calculatingHalos = `false`
	)

protected

Compute a corner

void ComputeSegments ( void )

protected

Computes the geometry for the line segments and invokes the appropriate corner method

void ComputeSegments	(	GlsPolyLineTriangleList &	array,
		float	thickness,
		bool	calculatingHalos = `false`
	)

protected

ComputeSegments helper method

virtual void CopyGeometry ( DisplayObject * src )

virtual

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

Parameters

src	The object to copy geometry from

Reimplemented from DisplayObject.

virtual void CopyProperties ( DisplayObject * src )

virtual

Copies the attributes except for geometry attributes from one object to another. Used by the undo mechanism to undo most attribute change operations.

Parameters

src	The object to copy properties from

Reimplemented from DisplayObject.

void DeleteVertexAt ( unsigned int index )

virtual

see base class

Reimplemented from GLPolygon.

virtual void Draw ( void )

virtual

Draws this object on the current display frame (_parent member).

Reimplemented from GLPolygon.

virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType * addToThisList = NULL )

virtual

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

Parameters

addToThisList If not NULL this list will be added to then returned. If NULL a new list will be created.

Returns: A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from DisplayObject.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType * array )

virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters

array Memory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from DisplayObject.

virtual void GetExtents	(	float &	x,
		float &	y,
		float &	z,
		float &	x1,
		float &	y1,
		float &	z1
	)

virtual

Figure out the static extents for the object. Used by the editor as part of the pick operation and for figuring out the size of groups.

Parameters

x	Gets the minimum x extent
y	Gets the minimum y extent
z	Gets the minimum z extent
x1	Gets the maximum x extent
y1	Gets the maximum y extent
z1	Gets the maximum z extent

Reimplemented from DisplayObject.

Vector GlobalNormal ( void )

inline

Get the normal for the polyline

void Halo ( const bool & val )

Enable/Disable halo

bool Halo ( void )

inline

Get the halo setting

void HaloColor ( const GlsColor & val )

Set the halo color

GlsColor HaloColor ( void )

inline

Get the halo color

void HaloThickness ( const float & val )

Set the halo thickness

Parameters

val	The new halo thickness in logical units

float HaloThickness ( void )

inline

Get the halo thickness

Returns: The line thickness in logical units

virtual bool Hit	(	float	x,
		float	y,
		float	z,
		float	scale,
		const Vector &	directionVector,
		Vector *	collisionPoint
	)

virtual

Determines if the object is hit by a pick ray starting at (x,y,z) and pointing towards directionVector in object logical coordinate system. If Pickable() == PICK_BEST it will return the closest point that was hit, otherwise it returns the first point that was hit. This method should not pick points behind the viewer.

Parameters

x	X coordinate of pick ray start in logical coordinates.
y	Y coordinate of pick ray start in logical coordinates.
y	Y coordinate of pick ray start in logical coordinates.
z	Z coordinate of pick ray start in logical coordinates.
scale	The scale factor of the window. Affects picking of outlines. Standard value is 1.0.
directionVector	The direction of the pick ray.
collisionPoint	If this method returns true, this Vector will contain the location that was hit in logical coordinates.

Returns: boolean indicating if the object was hit by the pick ray.

Reimplemented from DisplayObject.

virtual void PolygonEnd ( const int end )

virtual

Sets the polygon end mode (Open or Closed) for the polygon

Parameters

end	Enumeration indicating open or closed mode

See also: PolygonClose_e

Reimplemented from DisplayObject.

virtual void PreDraw	(	const OpenGLMatrices &	current,
		Culler &	culler
	)

virtual

Traverses the hierarchy calculating the _modelMatrix, _projMatrix, _viewMatrix as needed.

Parameters

current	Current matrices inherited from parent
culler	Object that possibly marks this object for culling

Reimplemented from DisplayObject.

virtual void Rotate	(	const Vector &	orig,
		float	angle,
		const Vector &	axis
	)

virtual

Rotates the object (around the specified axis) by the angle indicated, at the point specified. Recalculates the vertex data.

Parameters

orig	The point to rotate around
angle	The angle to rotate by, in degrees
axis	The arbitrary axis to rotate the object around

Reimplemented from DisplayObject.

virtual void Scale	(	float	px,
		float	py,
		float	pz,
		Vertex *	anchor,
		int	handleBar
	)

virtual

Scales the object, either the handleBar, or the Anchor is used to translate the object, not both. Anchor takes presidence, if it is set HandleBar is ignored. The footprint is different from the 2D scale so the compiler can destinguish the two.

Parameters

px	Value of the percentage of scale in x-axis
py	Value of the percentage of scale in y-axis
pz	Value of the percentage of scale in z-axis
anchor	Anchor from which to scale object relative to
handleBar	Vertex that is being dragged

Reimplemented from DisplayObject.

virtual void SetAvailableAttributes ( unsigned int value )

virtual

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

Parameters

value A bitfield specifying which types of attributes to make available.

See also: AvailableAttributesEnum

Reimplemented from DisplayObject.

virtual void SetColor ( const GlsColor & color )

virtual

Sets the RGBA color for the object outline

Parameters

color The new color

Reimplemented from DisplayObject.

virtual void SetFillColor ( const GlsColor & color )

virtual

Sets the RGBA color for filling the object

Parameters

color The new RGBA fill color (0-255 range) for the object

Reimplemented from DisplayObject.

virtual void SetRecalculate ( void )

virtual

Set the recalculate flag for the object to force it to recalculate

virtual void SetValue	(	int	spec,
		va_list &	args
	)

virtual

Sets an attribute of this object using variable arguments

Parameters

spec	A GLS_Initializer tag
args	A variable argument list

Reimplemented from DisplayObject.

virtual void SetVertices	(	unsigned int	nPoints,
		Vertex *	vertices
	)

virtual

Sets the vertex data for this polygon You should call UpdateBoundingVolume after changing an objects extents.

See also: UpdateBoundingVolume

Parameters

nPoints	The number of vertices in the object
vertices	The vertex data for the object

Reimplemented from DisplayObject.

void Thickness ( const float & val )

Sets the line thickness

Parameters

val	The new line thickness in logical units

float Thickness ( void )

inline

Gets the line thickness

Returns: The line thickness in logical units

void UpdateHaloEndCaps ( )

protected

updates the end-cap hang over for the halos

void VerticesChanged ( void )

protected

notify that vertices have changed updates bounding volume and sets recalculate for polyline

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

gls_poly_line.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation