#include <gls_schematic_poly_line_interconnect.h>

Inheritance diagram for GlsSchematicPolyLineInterconnect:

Classes
struct	CornerCircle

struct	InterconnectVertex

Public Member Functions
	GlsSchematicPolyLineInterconnect (void)

virtual	~GlsSchematicPolyLineInterconnect ()

virtual void	SetAvailableAttributes (unsigned int value)

virtual DisplayObject *	CloneObject (bool generateNames=false)

virtual void	CopyGeometry (DisplayObject *src)

virtual void	CopyProperties (DisplayObject *src)

virtual InterfaceListType *	GetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)

virtual void	GetCppInterfaceDescriptionFree (InterfaceListType *array)

virtual void	Calculate (double time)

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

virtual void	Draw (void)

virtual void	CalculateTextureCoordinates (void)

virtual DisplayObject *	handle (DisplayEvent *ev)

virtual void	SetValue (int spec, va_list &args)

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

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

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

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

virtual Vertex	WorldVertex (unsigned int i)

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

virtual void	DeleteVertex (unsigned int index)

virtual void	InsertVertex (unsigned int index)

virtual void	SetOrientationVectors (const Vector &iVector, const Vector &jVector)

virtual void	GetOrientationVectors (Vector &iVector, Vector &jVector)

virtual void	SetLineThickness (const float lineThickness)

virtual float	GetLineThickness (void)

virtual void	SetRoundedCorners (const bool roundedCorners)

virtual bool	GetRoundedCorners (void)

virtual void	SetCornerRadius (const float cornerRadius)

virtual float	GetCornerRadius (void)

virtual void	SetForceExactCornerRadius (const bool forceExactCornerRadius)

virtual bool	GetForceExactCornerRadius (void)

virtual void	SetCornerSegments (const unsigned int cornerSegments)

virtual unsigned int	GetCornerSegments (void)

virtual void	SetInterconnectTextureIndex (const int interconnectTextureIndex)

virtual int	GetInterconnectTextureIndex (void)

virtual void	SetInterconnectTextureRepeatLength (const float interconnectTextureRepeatLength)

virtual float	GetInterconnectTextureRepeatLength (void)

virtual void	SetFlowTextureIndex (const int flowTextureIndex)

virtual int	GetFlowTextureIndex (void)

virtual void	SetFlowTextureRepeatLength (const float flowTextureRepeatLength)

virtual float	GetFlowTextureRepeatLength (void)

virtual void	SetShowFlow (const bool showFlow)

virtual bool	GetShowFlow (void)

virtual void	SetFlowRate (const float flowRate)

virtual float	GetFlowRate (void)

virtual void	SetShowFlowBlink (const bool showFlowBlink)

virtual bool	GetShowFlowBlink (void)

virtual void	SetFlowBlinkRate (const float flowBlinkRate)

virtual float	GetFlowBlinkRate (void)

virtual void	SetFlowBlinkStartColor (const GlsColor &startColor)

virtual GlsColor	GetFlowBlinkStartColor (void)

virtual void	SetFlowBlinkEndColor (const GlsColor &endColor)

virtual GlsColor	GetFlowBlinkEndColor (void)

virtual void	SetUseDisplayList (const bool useDisplayList)

virtual bool	GetUseDisplayList (void)

virtual void	SetEndingChamferDistance (const float endingChamferDistance)

virtual float	GetEndingChamferDistance (void)

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

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

	GLPolygon (void)

	GLPolygon (const GLPolygon &polygon, const bool generateNames)

virtual	~GLPolygon (void)

void	ConfigureMetaData (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)

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)

virtual void	SetColor (const GlsColor &color)

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 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	SetFillColor (const GlsColor &color)

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

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 void	PolygonEnd (const int end)

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 ()

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	Scale (int handleBar, float px, float py, Vertex *anchor=NULL)

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 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)

Public Member Functions inherited from AttributeChangedNotifier
virtual	~AttributeChangedNotifier ()

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

void	NotifyWeakReferenceDestroyed (WeakReference *ref)

Protected Types
typedef DynamicArray< InterconnectVertex, true >	InterconnectVertexArray

typedef DynamicArray< CornerCircle, true >	CornerCircleArray

typedef DynamicArray< Vector, true >	VectorArray

Protected Member Functions
virtual void	VerticesChanged (void)

virtual void	OrientationChanged (void)

virtual GlsMatrixType	GetOrientationMatrix (void)

virtual void	SetRebuild (void)

virtual void	Rebuild (void)

virtual void	EmitInterconnectGeometry (const bool drawFlowUVs)

virtual void	EnablePreviewPath (const bool enablePreviewPath)

virtual void	EmitPreviewPathGeometry (void)

virtual VectorArray	GetUniqueVerts (const unsigned int numVertices, Vertex *vertices)

virtual bool	FindCornerCircle (const Vector &v0, const Vector &v1, const Vector &v2, const float desiredCornerRadius, const float minRadius, const bool forceExactCornerRadius, CornerCircle &c, bool forceCircle=false)

virtual float	ComputePathLength (CornerCircleArray &cornerCircles)

virtual float	AddInterconnectLineSegment (InterconnectVertexArray &interconnectVerts, const Vector &start, const Vector &finish, float lineThickness, float curLength, const float totalLength, const unsigned int numInterconnectRepeats, const unsigned int numFlowRepeats, const bool lastSegmentInPath=false)

virtual float	AddInterconnectRoundedCorner (InterconnectVertexArray &interconnectVerts, const CornerCircle &c, float lineThickness, float curLength, const float totalLength, const unsigned int numInterconnectRepeats, const unsigned int numFlowRepeats)

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 ()

Protected Attributes
Vector	_orientation [2]

float	_lineThickness

bool	_roundedCorners

float	_cornerRadius

bool	_forceExactCornerRadius

unsigned int	_cornerSegments

float	_interconnectTextureRepeatLength

int	_flowTextureIndex

float	_flowTextureRepeatLength

bool	_showFlow

float	_flowRate

bool	_showFlowBlink

float	_flowBlinkRate

GlsColor	_flowBlinkStartColor

GlsColor	_flowBlinkEndColor

bool	_needsRebuild

double	_lastCalculateTime

InterconnectVertexArray	_interconnectVerts

bool	_useDisplayList

GlsDisplayList	_interconnectDisplayList

GlsDisplayList	_flowDisplayList

float	_endingChamferDistance

bool	_drawPreviewPath

VectorArray	_previewPathPoints

CornerCircleArray	_previewCornerCircles

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

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)

Detailed Description

Runtime implementation of a GlsSchematicPolyLineInterconnect

Member Typedef Documentation

typedef DynamicArray<CornerCircle, true> CornerCircleArray

protected

array of CornerCircle

typedef DynamicArray<InterconnectVertex, true> InterconnectVertexArray

protected

array of InterconnectVertex

typedef DynamicArray<Vector, true> VectorArray

protected

array of Vector

Constructor & Destructor Documentation

GlsSchematicPolyLineInterconnect ( void )

Create a new GlsSchematicPolyLineInterconnect. for this inputdevice

virtual ~GlsSchematicPolyLineInterconnect ( )

virtual

Destructs a GlsSchematicPolyLineInterconnect object

Member Function Documentation

virtual float AddInterconnectLineSegment	(	InterconnectVertexArray &	interconnectVerts,
		const Vector &	start,
		const Vector &	finish,
		float	lineThickness,
		float	curLength,
		const float	totalLength,
		const unsigned int	numInterconnectRepeats,
		const unsigned int	numFlowRepeats,
		const bool	lastSegmentInPath = `false`
	)

protectedvirtual

Add a line segment to the given array of interconnect verts

Parameters

interconnectVerts	receives line segment is start and finish are not virtually the same point
start	starting point of line segment
finish	finish point of line segment
lineThickness	thickness of line segment
curLength	current length of path at the starting point
totalLength	total length of path that contains the line segment
numInterconnectRepeats	number of interconnect texture repeats over entire path that contains the line segment
numFlowRepeats	number of flow texture repeats over entire path that contains the line segment
lastSegmentInPath	[optional, defaults to false] true if this line segment is the last in the path

virtual float AddInterconnectRoundedCorner	(	InterconnectVertexArray &	interconnectVerts,
		const CornerCircle &	c,
		float	lineThickness,
		float	curLength,
		const float	totalLength,
		const unsigned int	numInterconnectRepeats,
		const unsigned int	numFlowRepeats
	)

protectedvirtual

Add a rounded to the given array of interconnect verts

Parameters

interconnectVerts	receives line segment is start and finish are not virtually the same point
c	info for rounded corner to add
lineThickness	thickness of line segment
curLength	current length of path at the starting point
totalLength	total length of path that contains the line segment
numInterconnectRepeats	number of interconnect texture repeats over entire path that contains the line segment
numFlowRepeats	number of flow texture repeats over entire path that contains the line segment

virtual void Calculate ( double time )

virtual

Provides a mechanism for performing regular calculations, seperate from drawing. In a standalone applicaton Calculate is recursively called by the main loop before the objects are drawn.

Parameters

time	The elaspsed time in seconds since program start

Reimplemented from DisplayObject.

virtual void CalculateTextureCoordinates ( void )

virtual

Recalculates the texture coordinates for the object based on the TexturePoints.

Reimplemented from GLPolygon.

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.

virtual float ComputePathLength ( CornerCircleArray & cornerCircles )

protectedvirtual

Compute the length of the path described by the given corner array

Parameters

cornerCircles corners in question

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.

virtual void DeleteVertex ( unsigned int index )

virtual

DeleteVertex is overloaded in polygon to prevent having a poly with less than 2 verts. This prevents incorrect GL calls when polygon is set to POLY_MODE_FILLED

Reimplemented from GLPolygon.

virtual void Draw ( void )

virtual

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

Reimplemented from GLPolygon.

virtual void EmitInterconnectGeometry ( const bool drawFlowUVs )

protectedvirtual

emit the geomentry in _interconnectQuads to OpenGL as quads and an outline

Parameters

drawFlowUVs true to draw with flow UV's else false to draw with interconnect UV's

virtual void EmitPreviewPathGeometry ( void )

protectedvirtual

emit the preview path geometry to GL – mainly used fir debugging and when the line is selected in the editor

virtual void EnablePreviewPath ( const bool enablePreviewPath )

protectedvirtual

turn on/off preview Path drawing ( useful for debugging and when the object is selected in the editor )

Parameters

enablePreviewPath true to enable else false

virtual bool FindCornerCircle	(	const Vector &	v0,
		const Vector &	v1,
		const Vector &	v2,
		const float	desiredCornerRadius,
		const float	minRadius,
		const bool	forceExactCornerRadius,
		CornerCircle &	c,
		bool	forceCircle = `false`
	)

protectedvirtual

Find a corner circle that will fit the corner defined by v0 -> v1 -> v2

Parameters

v0	starting point
v1	corner point
v2	ending point
desiredCornerRadius	desired radius for corner circle
minRadius	minimum radius for ccorner circle
forceExactCornerRadius	true if the corner can only be rounded with a radius equal to the desiredCornerRadius else false to allow a smaller radius to be used if needed (>minRadius)
c	[out] receives corner info
forceCircle	[optional, defaults to false] true to force a rounded corner to be found (used to avoid lack of precision issues when the circle is tangent at the midpoint of either v0 -> v1, or v1 -> v2

Returns: true if a rounded corner was found

virtual float GetCornerRadius ( void )

virtual

get the corner radius in logical units

Returns: the corner radius in logical units

virtual unsigned int GetCornerSegments ( void )

virtual

get the number of segments used in rounded corners

Returns: the number of segments used in rounded corners

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 float GetEndingChamferDistance ( void )

virtual

get the last segment chamfer distance (NOTE: not controllable in editor, usually used by the GlsSchematicTeeInterconnect plugin at runtime)

Returns: distance from end of last line segment to start chamfer ( 0.0f to disable )

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.

virtual GlsColor GetFlowBlinkEndColor ( void )

virtual

get the flow blink end color

Returns: the flow blink end color

virtual float GetFlowBlinkRate ( void )

virtual

get the flow blink rate in hz

Returns: the flow blink rate in hz

virtual GlsColor GetFlowBlinkStartColor ( void )

virtual

get the flow blink start color

Returns: the flow blink start color

virtual float GetFlowRate ( void )

virtual

get the flow rate in "flow textures" / second

Returns: the flow rate in "flow textures" / second

virtual int GetFlowTextureIndex ( void )

virtual

get the flow texture index else NO_TEXTURE if no flow texture

Returns: the flow texture index else NO_TEXTURE if no flow texture

virtual float GetFlowTextureRepeatLength ( void )

virtual

get the number of logical units per flow texture repeat ( >0.0 )

Returns: the number of logical units per flow texture repeat ( >0.0 )

virtual bool GetForceExactCornerRadius ( void )

virtual

get force exact corner radius state

Returns: force exact corner radius state

virtual int GetInterconnectTextureIndex ( void )

virtual

get the interconnect texture index else NO_TEXTURE if no interconnect texture

Returns: the interconnect texture index else NO_TEXTURE if no interconnect texture

virtual float GetInterconnectTextureRepeatLength ( void )

virtual

get the number of logical units per interconnect texture repeat ( >0.0 )

Returns: the number of logical units per interconnect texture repeat ( >0.0 )

virtual float GetLineThickness ( void )

virtual

get the line thickness in logical units

Returns: the line thickness in logical units

virtual GlsMatrixType GetOrientationMatrix ( void )

protectedvirtual

get the rotation matrix for the current _orientation vectors

Returns: the rotation matrix for the current _orientation vectors

virtual void GetOrientationVectors	(	Vector &	iVector,
		Vector &	jVector
	)

virtual

get the i and j orientation vectors that orient the 2-D schematic in 3 space

Parameters

iVector	[out] iVector
jVector	[out] jVector

virtual bool GetRoundedCorners ( void )

virtual

get rounded corners

Returns: rounded corners

virtual bool GetShowFlow ( void )

virtual

get whether or not the flow is displayed

Returns: true if flow is show else false

virtual bool GetShowFlowBlink ( void )

virtual

get whether or not the flow blink is displayed (NOTE: normal flow is not drawn if flow blink is true)

Returns: true if flow blink is shown else false

virtual VectorArray GetUniqueVerts	(	const unsigned int	numVertices,
		Vertex *	vertices
	)

protectedvirtual

Eliminate adjacent vertices that are not unique between each other

Parameters

numVertices	number of input vertices
vertices	input vertices

Returns: array of unique verts

virtual bool GetUseDisplayList ( void )

virtual

get use display list

Returns: true if using display list for drawing

virtual DisplayObject* handle ( DisplayEvent * ev )

virtual

Handles an event that is sent to the object.

Parameters

ev	The event to send to the object

Returns: Which object handled the event

Reimplemented from DisplayObject.

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 InsertVertex ( unsigned int index )

virtual

Insert a vertex at an index. Duplicate the vertex pointed to by index, so that there are two vertices that are exactly the same.

Parameters

index The index to insert the vertex at (1 based, not zero)

Reimplemented from DisplayObject.

virtual void OrientationChanged ( void )

protectedvirtual

notify that the orientation vectors have changed

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 Rebuild ( void )

protectedvirtual

rebuild the polyline

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 = `0`
	)

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 SetCornerRadius ( const float cornerRadius )

virtual

set the corner radius in logical units

Parameters

cornerRadius new corner radisu in logical units

Precondition: cornerRadius > 0.0f

virtual void SetCornerSegments ( const unsigned int cornerSegments )

virtual

set the number of segments used in rounded corners

Parameters

cornerSegments number of segments to use in rounded corners

Precondition: 2 <= cornerSegments <= 100

virtual void SetEndingChamferDistance ( const float endingChamferDistance )

virtual

set the last segment chamfer distance (NOTE: not controllable in editor, usually used by the GlsSchematicTeeInterconnect plugin at runtime)

Parameters

endingChamferDistance distance from end of last line segment to start chamfer ( 0.0f to disable )

Precondition: endingChamferDistance >= 0.0f

virtual void SetFlowBlinkEndColor ( const GlsColor & endColor )

virtual

set the flow blink end color

Parameters

endColor flow blink end color

virtual void SetFlowBlinkRate ( const float flowBlinkRate )

virtual

set the flow blink rate in hz

Parameters

flowBlinkRate flow blink rate in hz

virtual void SetFlowBlinkStartColor ( const GlsColor & startColor )

virtual

set the flow blink start color

Parameters

startColor flow blink start color

virtual void SetFlowRate ( const float flowRate )

virtual

set the flow rate in "flow textures" / second

Parameters

flowRate flow rate in "flow textures" / second

virtual void SetFlowTextureIndex ( const int flowTextureIndex )

virtual

set the flow texture index

Parameters

flowTextureIndex new flow texture index else NO_TEXTURE if no flow texture

virtual void SetFlowTextureRepeatLength ( const float flowTextureRepeatLength )

virtual

set the number of logical units per flow texture repeat ( >0.0 ) NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures lineup

Parameters

flowTextureRepeatLength new flow texture repeat length

Precondition: flowTextureRepeatLength > 0.0f

virtual void SetForceExactCornerRadius ( const bool forceExactCornerRadius )

virtual

set force exact corner radius

Parameters

forceExactCornerRadius true to force rounded corners to use the exact corner radius specified by SetCornerRadius(). If true, a corner that cannot be made with this radius will not be rounded.

virtual void SetInterconnectTextureIndex ( const int interconnectTextureIndex )

virtual

set the interconnect texture index

Parameters

interconnectTextureIndex new interconnect texture index else NO_TEXTURE if no interconnect texture

virtual void SetInterconnectTextureRepeatLength ( const float interconnectTextureRepeatLength )

virtual

set the number of logical units per interconnect texture repeat ( >0.0 ) NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures lineup

Parameters

interconnectTextureRepeatLength new interconnect texture repeat length

Precondition: interconnectTextureRepeatLength > 0.0f

virtual void SetLineThickness ( const float lineThickness )

virtual

set the line thickness in logical units

Parameters

lineThickness new line thickness in logical units

Precondition: lineThickness > 0.0f

virtual void SetOrientationVectors	(	const Vector &	iVector,
		const Vector &	jVector
	)

virtual

set the i and j orientation vectors that orient the 2-D schematic in 3 space

Parameters

iVector	new iVector
jVector	new jVector

Precondition: i and j should be orhogonal

virtual void SetRebuild ( void )

protectedvirtual

flag line to be rebuilt on next draw

virtual void SetRoundedCorners ( const bool roundedCorners )

virtual

set rounded corners

Parameters

roundedCorners true for rounded corners

virtual void SetShowFlow ( const bool showFlow )

virtual

set whether or not the flow is displayed

Parameters

showFlow true to show flow else false

virtual void SetShowFlowBlink ( const bool showFlowBlink )

virtual

set whether or not the flow blink is displayed (NOTE: normal flow is not drawn if flow blink is true)

Parameters

showFlowBlink true to show flow blink else false

virtual void SetUseDisplayList ( const bool useDisplayList )

virtual

enable/disable using display list for drawing

Parameters

useDisplayList true to use display list

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.

virtual void VerticesChanged ( void )

protectedvirtual

notify that vertices have changed

virtual Vertex WorldVertex ( unsigned int i )

virtual

Gets a vertex from the object, in World coordinates (i.e. not relative to the location as is the case with the Vertices() API call).

Parameters

i	Index of the vertex to get

Returns: The vertex

Reimplemented from DisplayObject.

Member Data Documentation

float _cornerRadius

protected

radius for rounded corners ( >0.0 )

unsigned int _cornerSegments

protected

number of segments to use in rounded corners (2 <= cornerSegments <= 100)

bool _drawPreviewPath

protected

true to draw the preview path (mainly used in editor)

float _endingChamferDistance

protected

distance from end of last line segment to start chamfer ( 0.0f to disable ) ( >= 0.0f )

GlsColor _flowBlinkEndColor

protected

ending color for flow blink

float _flowBlinkRate

protected

rate of flow blink in hz >= 0.0

GlsColor _flowBlinkStartColor

protected

starting color for flow blink

GlsDisplayList _flowDisplayList

protected

display list for drawing flow (if using display lists)

float _flowRate

protected

the flow rate in "flow textures" / second

int _flowTextureIndex

protected

texture index for flow texture else NO_TEXTURE

float _flowTextureRepeatLength

protected

number of logical units per flow texture repeat ( >0.0 ) NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures lineup

bool _forceExactCornerRadius

protected

true to force rounded corners to use the exact corner radius specified by _cornerRadius. If true, a corner that cannot be made with this radius will not be rounded.

GlsDisplayList _interconnectDisplayList

protected

display list for drawing interconnect (if using display lists)

float _interconnectTextureRepeatLength

protected

number of logical units per interconnect texture repeat ( >0.0 ) NOTE: number of actual repeats for the whole interconnect is always rounded to the nearest whole number so that adjacent interconnect's textures lineup

InterconnectVertexArray _interconnectVerts

protected

2D verts and texture coords computed for interconnect

double _lastCalculateTime

protected

last time stamp given to Calculate() method

float _lineThickness

protected

thickness of line in logical units ( >0.0 )

bool _needsRebuild

protected

true if the line needs to be rebuilt

Vector _orientation[2]

protected

Two orthogonal vectors defining the orientation

CornerCircleArray _previewCornerCircles

protected

corners in preview path

VectorArray _previewPathPoints

protected

points in preview path

bool _roundedCorners

protected

true for rounded corners

bool _showFlow

protected

true to draw flow in interconnect else false

bool _showFlowBlink

protected

true to draw the flow blink else false (NOTE: normal flow is not drawn if flow blink is true)

bool _useDisplayList

protected

true to draw using display lists

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

gls_schematic_poly_line_interconnect.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation