#include <gls_map_symbology.h>

Inheritance diagram for GlsMapSymbology:

Public Member Functions
	GlsMapSymbology (bool generateInstance=false)

virtual	~GlsMapSymbology ()

virtual void	SetAvailableAttributes (unsigned int value)

virtual DisplayObject *	CloneObject (bool generateNames=false)

virtual void	CopyProperties (DisplayObject *src)

virtual InterfaceListType *	GetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)

virtual void	GetCppInterfaceDescriptionFree (InterfaceListType *array)

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

virtual void	Draw (void)

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

virtual DisplayObject *	handle (DisplayEvent *ev)

virtual void	SetValue (int spec, va_list &args)

GlsMapView *	GetMapView ()

virtual void	SetDataSource (GlsMapSymbologyDataSource *database)

GlsMapSymbologyDataSource *	GetDataSource ()

GlsMapSymbologyStdDataSource *	GetStdDataSource ()

virtual bool	PickSymbols (GlsMapView view, LocationEvent lev, GlsMapSymbologyDataSource::IconIDList iconsHit, GlsMapSymbologyDataSource::PathIDList pathsHit)

void	SetDefaultPathColor (const glsColor &value)

Public Member Functions inherited from Group
DisplayObject *	FindByName (const char *name)

virtual DisplayObject *	FindByNameSameFrame (const char *name)

DisplayObject *	FindByName (DisplayObject *obj)

DisplayObject *	FindByQualifiedName (const char *name)

DisplayObject *	FindNonRecursive (DisplayObject *obj)

DisplayObjectArray &	Objects ()

const DisplayObjectArray &	Objects () const

DisplayObject *	Item (unsigned int index)

bool	PerformGroupCullCheck (void) const

void	PerformGroupCullCheck (bool mode)

bool	CullTestChildren (void) const

void	CullTestChildren (bool mode)

unsigned int	Count (void) const

DisplayObjectPtr	operator[] (unsigned int index)

const DisplayObject *	operator[] (unsigned int index) const

DisplayObject *	FirstObject ()

DisplayObject *	LastObject (void)

bool	IsEmpty () const

int	Position (const DisplayObject *obj) const

	Group (int generateInstance=0)

	Group (const Group &group, bool generateNames)

void	InitialGroupCount (unsigned int cnt)

virtual	~Group ()

virtual void	DeleteAllChildren ()

virtual void	CopyGeometry (DisplayObject *src) override

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

virtual void	Parent (DisplayFrame *par) override

void	SetPainter (GlsPainter *painter) override

virtual void	Location (const Vertex &v) override

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

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

virtual void	Translate (float transAmount[]) override

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

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

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

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

void	Scale (float scale_x, float scale_y, float scale_z, Vertex *anchor=NULL, int handle=0) override

virtual void	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=-1)

virtual bool	DeleteObject (DisplayObject *obj, bool recalculateBoundingbox=true)

virtual void	ReorderObject (unsigned int oldIndex, unsigned int newIndex)

virtual void	PushObject (DisplayObject *obj)

void	DeleteVertexAt (unsigned) override

void	InsertVertexAt (unsigned) override

virtual void	SetGroupLocation (const Vertex &v)

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

virtual void	CalculateTextureCoordinates (void) override

virtual void	LineWidth (float width) override

virtual float	LineWidth (void) override

virtual void	LineStipplePattern (int pattern) override

virtual int	LineStipplePattern (void) override

virtual void	LineStippleMultiplier (int mult) override

virtual int	LineStippleMultiplier (void) override

virtual int	PolygonMode (void) override

virtual void	PolygonMode (int mode) override

virtual void	PolygonEnd (const int mode) override

virtual int	PolygonEnd (void) override

virtual void	Shading (const int mode) override

virtual int	Shading (void) override

virtual void	DepthTest (unsigned char mode) override

virtual int	DepthTest (void) override

virtual void	AntiAlias (bool mode) override

virtual bool	AntiAlias (void) override

virtual void	AlphaMode (int mode) override

virtual int	AlphaMode (void) override

virtual void	CullBackFace (const bool mode) override

virtual bool	CullBackFace (void) override

virtual bool	LightingEnabled () override

virtual void	LightingEnabled (bool lighting) override

virtual void	SetBlendColor (const GlsColor &color) override

virtual GlsColor	GetBlendColor (void) override

virtual void	SetColor (const GlsColor &color) override

virtual GlsColor	GetColor (void) override

virtual void	SetFillColor (const GlsColor &color) override

virtual GlsColor	GetFillColor (void) override

virtual void	TextureRepeat (const int rep) override

virtual void	TextureMappingTechnique (const int map) override

virtual int	TextureMappingTechnique (void) override

virtual void	TextureMinificationFilter (const int filter) override

virtual int	TextureMinificationFilter (void) override

virtual void	TextureMagnificationFilter (const int filter) override

virtual int	TextureMagnificationFilter (void) override

virtual void	Calculate (double time) override

CompatabilityListItem *	First ()

CompatabilityListItem *	Last ()

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

void	ApplyTextureSettings (int textureIndex=-1)

DistiAttribDict &	Attributes ()

void	GetBlendColor (unsigned char color[])

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

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)

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)

bool	Culled () const

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

GlsMatrixType &	DcsMatrix ()

void	DcsMatrix (const GlsMatrixType &matrix)

virtual void	DeleteVertexAt (unsigned int index)

virtual void	DeleteVertex (unsigned int indexAfter) final

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

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

void	SetFillColor (unsigned char c4[])

virtual void	FinishObject ()

virtual void	GenerateInstanceName (void)

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 const Vertex &	Location (void) const

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)

DisplayFrame *	Parent (void) const

virtual void	ParentGroup (Group *group)

Group *	ParentGroup (void) const

unsigned char	Pickable ()

virtual void	Pickable (unsigned char pick)

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)

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

void *	UserData (void) const

void	UserData (void *data)

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

virtual Vertex *	Vertices ()

virtual void	SetVertices (unsigned int nPoints, 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 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

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 Member Functions inherited from Group
virtual void	AddAvailableAttributes (unsigned int availableAttributes)

virtual void	GrowBoundingBox (DisplayObject *obj)

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

The GlsMapSymbology class is a Group that contains a collection of DisplayObjects that can be thought of as 'icon templates'. When drawing, the MapSymbologyLayer will query it's MapSymbologyDataSource for the list of visible icons and paths, then render them to the map using the icon templates. The MapSymbologyDataSource interface is simple, while still allowing the MapSymbologyDataSource the ability to override the appearance of icons and paths.

When a new GlsMapSymbology instance is first created, it will create it's own GlsMapSymbologyStdDataSource which provides an interface for the user to create/update icons and paths without having to write their own MapSymbologyDataSource class. While this class provides much of the common functionality that is needed, some users will still want to create their own MapSymbologyDataSource to provide the best performance when working with their own datasets. These users have the option of deriving from the BasicDataSource class (a template class which provides basic functionality) or deriving directly from MapSymbologyDataSource interface to optimize all of the MapSymbologyDataSource code for their data set.

Constructor & Destructor Documentation

GlsMapSymbology ( bool generateInstance = false )

Create a new GlsMapSymbology.

Parameters

generateInstance Whether or not to generate an instance name for this inputdevice

virtual ~GlsMapSymbology ( )

virtual

Destructs a GlsMapSymbology 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 Group.

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 Group.

virtual void Draw ( void )

virtual

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

Reimplemented from Group.

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 Group.

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 Group.

GlsMapSymbologyDataSource* GetDataSource ( )

inline

Returns the MapSymbologyDataSource that this object is using. This may be the default GlsMapSymbologyStdDataSource or another data source that was provided using the SetDataSource() method.

Returns: pointer to the MapSymbologyDataSource this GlsMapSymbology is using.

GlsMapView* GetMapView ( )

inline

Returns: pointer to the GlsMapView that the symbology will use for rendering or NULL if not found.

GlsMapSymbologyStdDataSource* GetStdDataSource ( )

Returns: pointer to the GlsMapSymbologyStdDataSource for this symbology or NULL if another type of data source is being used.

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 DisplayObject* Pick3D	(	const Vector &	winLoc,
		const Vector &	logicalCoords,
		float	scale,
		const Vector &	directionVector,
		Vector &	collisionWinLoc,
		const OpenGLMatrices &	drawnMatrices
	)

virtual

Attempts to pick an object in 3D and accounting for dynamic rotations and translations of this object or parent objects. It also looks at the pickable status and attempts to return the "Best" pick if that is what is desired.

Note: This method will pick objects in the scene based on a pick ray starting at winLoc and pointing into the screen. It will not pick objects behind the depth specified by winLoc.z. Typically winLoc.z should be set to 0 to ensure that the pick ray starts at near clip plane.

Parameters

winLoc	Device coordinates for the mouse click. Z value should be set to 0 to ensure pick ray starts at near clip plane.
logicalCoords	The start of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
scale	Current window scale. Affects picking radius of outlines. Initial value should typically be 1.0.
directionVector	The direction of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
collisionWinLoc	Returns where the pick vector intersects the object that is hit in device coordinates.
drawnMatrices	The matrices used to draw the object, including matrices set by parents that may have dynamically rotated, translated or scaled this object. Initial value should typically be a default OpenGLMatrices() object.

Returns: The object that was hit, or NULL if no object hit

Reimplemented from Group.

virtual bool PickSymbols	(	GlsMapView *	view,
		LocationEvent *	lev,
		GlsMapSymbologyDataSource::IconIDList *	iconsHit,
		GlsMapSymbologyDataSource::PathIDList *	pathsHit
	)

virtual

Utility method that can be called by the user from the GlsMapView event callback to determine if any symbols were picked. If the method returns true, then iconsHit and pathsHit will contain the list of icons and paths that were picked. NOTE: This method uses the generic MapSymbologyDataSource interface in it's picking algorithm. If you are using a derived DataSource class that has it's own picking method, it will probably be faster than this method.

Parameters

view	The GlsMapView that was picked
lev	A LocationEvent indicating the point that was picked
iconsHit	IconIDList to receive the list of icons that were picked
pathsHit	PathIDList to receive the list of paths that were picked

Returns: true if an icon or path was picked

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 Group.

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 Group.

virtual void SetDataSource ( GlsMapSymbologyDataSource * database )

virtual

Set the MapSymbologyDataSource to use for rendering. The creator of the MapSymbologyDataSource instance is responsible for deleting it.

Parameters

database Pointer to the MapSymbologyDataSource to use

void SetDefaultPathColor ( const glsColor & value )

Set the default color for path lines This is only used if the MapSymbologyDataSource does not provide geometry for the paths

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.

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

gls_map_symbology.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation