GL Studio C++ Runtime API
GlsLinearScale Class Reference

#include <gls_linear_scale.h>

Inheritance diagram for GlsLinearScale:
GLPolygon DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Public Types

typedef GLPolygon _BaseClass
 Deprecated typedef for the base class.
 
typedef GLPolygon BaseClass
 Typedef for the base class.
 
- Public Types inherited from GLPolygon
typedef DisplayObject _BaseClass
 Deprecated typedef for the base class.
 
typedef DisplayObject BaseClass
 Typedef for the base class.
 
- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum {
  GLS_ATTRIBUTES_BASIC = 1 , GLS_ATTRIBUTES_DYNAMIC = 2 , GLS_ATTRIBUTES_APPEARANCE = 4 , GLS_ATTRIBUTES_GEOMETRY = 8 ,
  GLS_ATTRIBUTES_SPECIALIZED = 16 , GLS_ATTRIBUTES_ALL = ~0 , GLS_ATTRIBUTES_NONE = 0
}
 

Public Member Functions

 GlsLinearScale (bool generateInstance=false)
 
 GlsLinearScale (const GlsLinearScale &that, const bool generateNames)
 
virtual ~GlsLinearScale ()
 
virtual void SetAvailableAttributes (unsigned int value) DISTI_METHOD_OVERRIDE
 
virtual DisplayObjectCloneObject (bool generateNames=false) DISTI_METHOD_OVERRIDE
 
virtual void CopyProperties (DisplayObject *src) DISTI_METHOD_OVERRIDE
 
virtual void CopyGeometry (DisplayObject *srcArg) DISTI_METHOD_OVERRIDE
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL) DISTI_METHOD_OVERRIDE
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array) DISTI_METHOD_OVERRIDE
 
virtual void PreDraw (const OpenGLMatrices &parentMatrices, Culler &culler) DISTI_METHOD_OVERRIDE
 
virtual void Draw () DISTI_METHOD_OVERRIDE
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar) DISTI_METHOD_OVERRIDE
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis) DISTI_METHOD_OVERRIDE
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint) DISTI_METHOD_OVERRIDE
 
virtual void SetValue (int spec, va_list &args) DISTI_METHOD_OVERRIDE
 
virtual void SetColor (const GlsColor &color) DISTI_METHOD_OVERRIDE
 
void SetScale (int index, const GlsLinearScaleData &data)
 
void GetScale (int index, GlsLinearScaleData &data)
 
void DeconflictTicks (const bool &val)
 
bool DeconflictTicks ()
 
bool HaloEnabled ()
 
void HaloEnabled (const bool &val)
 
float HaloWidth ()
 
void HaloWidth (const float &val)
 
GlsColor HaloColor ()
 
void HaloColor (const GlsColor &val)
 
GlsTickAnchor TickAnchor ()
 
void TickAnchor (const GlsTickAnchor val)
 
bool UseScalableLines ()
 
void UseScalableLines (const bool &val)
 
void InvalidateGeometry ()
 
GlsDisplayListDisplayList ()
 
- Public Member Functions inherited from GLPolygon
 GLPolygon (unsigned int nPoints, const Vertex *vertices)
 
 GLPolygon (unsigned int nPoints, const Vertex *vertices, const Vertex &location)
 
 GLPolygon ()
 
 GLPolygon (const GLPolygon &polygon, const bool generateNames)
 
virtual ~GLPolygon ()
 
void ConfigureMetaData ()
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
virtual void Draw ()
 
virtual void CalculateTextureCoordinates ()
 
virtual void CalcNormals (int windingOrder=1)
 
virtual void DeleteVertexAt (unsigned int index)
 
virtual DisplayObjectPick3D (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 Destroy ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode ()
 
virtual bool AntiAlias ()
 
virtual void AntiAlias (bool alias)
 
void ApplyTextureSettings (int textureIndex=-1)
 
DistiAttribDictAttributes ()
 
const DistiAttribDictAttributes () const
 
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)
 
virtual bool BlinkedOff ()
 
virtual bool Blinking ()
 
virtual void Blinking (const bool blink)
 
virtual float BlinkRate ()
 
virtual void BlinkRate (const float rate)
 
const VectorBoundingVolumeCenter () 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 ()
 
virtual void CalculateTextureCoordinates ()
 
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
 
CallbackMethodCallerBaseCallbackCaller () const
 
void CallbackCaller (CallbackMethodCallerBase *cb)
 
virtual void GetCenter (Vector &center)
 
virtual DisplayObjectCloneObject (bool generateNames=false)=0
 
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 CopyGeometry (DisplayObject *src)
 
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
virtual void CullBackFace (const bool val)
 
virtual bool CullBackFace ()
 
bool Culled () const
 
void Culled (bool val)
 
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
 
GlsMatrixTypeDcsMatrix ()
 
GlsMatrixType DcsMatrix () const
 
void DcsMatrix (const GlsMatrixType &matrix)
 
virtual void DeleteVertexAt (unsigned int index)
 
virtual void DeleteVertex (unsigned int indexAfter) final
 
virtual int DepthTest ()
 
virtual void DepthTest (unsigned char zbuf)
 
virtual void Draw ()=0
 
const GlsMatrixTypeDrawMatrix ()
 
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 DynamicRotation ()
 
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)
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
 
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 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 void FinishObject ()
 
virtual void GenerateInstanceName ()
 
virtual DisplayObjecthandle (DisplayEvent *ev)
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
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 ()
 
const char * InstanceName () const
 
void InstanceName (const char *name)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual int LineStippleMultiplier ()
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStipplePattern ()
 
virtual void LineStipplePattern (int pattern)
 
virtual float LineWidth ()
 
virtual void LineWidth (float width)
 
virtual const VertexLocation () 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 () const
 
float Y () const
 
float Z () 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)
 
GlsMatrixTypeModelMatrix ()
 
bool NeedCalculate ()
 
VectorNormals ()
 
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
 
void VaSetNormals (unsigned int nPoints,...)
 
unsigned int NumberOfVertices () const
 
virtual float ObjectDepth ()
 
virtual float ObjectHeight ()
 
virtual float ObjectWidth ()
 
virtual void SetOrigin (const Vertex &vert)
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParent () const
 
virtual void ParentGroup (Group *group)
 
GroupParentGroup () const
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
 
unsigned char Pickable ()
 
virtual void Pickable (unsigned char pick)
 
virtual int PolygonEnd ()
 
virtual void PolygonEnd (const int end)
 
virtual int PolygonMode ()
 
virtual void PolygonMode (int mode)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
GlsMatrixTypeProjMatrix ()
 
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
 
virtual float RelativeAngle (const float x, const float y)
 
virtual DistiAttributeBaseResource (const char *name)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
 
void RestoreAlpha ()
 
void RestoreAntiAlias ()
 
void RestoreLighting ()
 
void RestoreLineStyle ()
 
const VertexRotationPoint () 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)
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
void SaveMatrices ()
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar=0)
 
void Set (int spec,...)
 
bool SetupAlpha ()
 
bool SetupAntiAlias ()
 
void SetupDepthTest ()
 
void SetupLighting ()
 
bool SetupLineStyle ()
 
void SetupPolyDrawStyle ()
 
void SetupShading ()
 
bool SetupTexture ()
 
virtual int Shading ()
 
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,...)
 
VectorTextureCoordinates ()
 
VectorGetTextureCoordinates ()
 
virtual int TextureIndex ()
 
virtual void TextureIndex (int textureIndex)
 
virtual VectorGetTexturePoints ()
 
virtual bool TextureRepeat ()
 
virtual void TextureRepeat (const int rep)
 
virtual int TextureMappingTechnique ()
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMagnificationFilter ()
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMinificationFilter ()
 
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 * UserData () const
 
void UserData (void *data)
 
virtual void SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
 
virtual VertexVertices ()
 
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
 
void VaSetVertices (unsigned int nPoints,...)
 
int * ViewMatrix ()
 
bool Visible () const
 
bool Visibility () const
 
virtual void Visibility (const bool vis)
 
virtual Vector WorldRotationPoint ()
 
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 GlsPainterGetPainter ()
 
void InvalidatePainter ()
 
virtual bool IsVisibleInScene (const DisplayObject *obj=NULL) const
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual void NotifyAttributeChanged (const AttributeName &name)=0
 
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef) override
 
void NotifyWeakReferenceDestroyed (WeakReference *ref) override
 
virtual void AddWeakReference (WeakReference *weakRef)=0
 
virtual void NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0
 

Static Public Member Functions

static DisplayObjectCreateInstance ()
 
- Static Public Member Functions inherited from GLPolygon
static DisplayObjectCreateInstance ()
 
- Static Public Member Functions inherited from DisplayObject
static InterfaceListTypeStaticGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
static void UseManualBlinkElapsedTime (bool useManualTime)
 
static void SetManualBlinkElapsedTime (double elapsedTime)
 

Protected Member Functions

void CurrentColor (const GlsColor &newColor)
 
void CurrentLineWidth (const float &newLineWidth)
 
void RecomputeVertices ()
 
void UpdateScaleData ()
 
bool TickNeeded (int currentLevel, float currentOffset)
 
void DrawScale (int i, float haloLength, float haloThickness)
 
virtual void DrawGeometry ()
 
- 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)
 
virtual int ColorMaterialMode ()
 
void AllocateModelMatrix ()
 
bool ApplyDynamicRotation ()
 
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 LastDrawMatrixLocation (const Vertex &loc)
 
const VertexLastDrawMatrixLocation ()
 
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)
 
virtual void SetValue (int spec, va_list &args)
 
int GetApplicableTextureIndex ()
 
int GetApplicableTextureRepeat ()
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin ()
 
virtual ~WeakReferenceableMixin ()
 

Protected Attributes

GlsColor _currentColor
 
float _currentLineWidth
 
bool _currentColorSet
 
bool _currentLineWidthSet
 
GlsDisplayList _displayList
 
Vector _radii [2]
 
Vector _radiiNormalized [2]
 
GlsLinearScaleDataArray _scale
 
bool _deconflictTicks
 
bool _haloEnabled
 
float _haloWidth
 
GlsColor _haloColor
 
GlsTickAnchor _tickAnchor
 
bool _useScalableLines
 
- 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
 
bool _needCalcDrawMatrix
 True if CalcDrawMatrix() needs to be called on this object.
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
DynamicArray< int > _materialIndices
 List of materials associated with this object.
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
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
 

Friends

class GlsLinearScaleEditor
 

Detailed Description

Runtime implementation of a GlsLinearScale

Constructor & Destructor Documentation

◆ GlsLinearScale() [1/2]

GlsLinearScale ( bool  generateInstance = false)

Create a new GlsLinearScale.

Parameters
generateInstanceWhether or not to generate an instance name for this inputdevice

◆ GlsLinearScale() [2/2]

GlsLinearScale ( const GlsLinearScale that,
const bool  generateNames 
)

Copy constructor

Parameters
thatThe object to copy from.
generateNamesWhether or not to generate an instance name.

◆ ~GlsLinearScale()

virtual ~GlsLinearScale ( )
virtual

Destructs a GlsLinearScale object

Member Function Documentation

◆ CloneObject()

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

◆ CopyGeometry()

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
srcThe object to copy geometry from

Reimplemented from DisplayObject.

◆ CopyProperties()

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
srcThe object to copy properties from

Reimplemented from DisplayObject.

◆ CreateInstance()

static DisplayObject * CreateInstance ( )
static
Returns
A pointer to a new GlsLinearScale object.

◆ CurrentColor()

void CurrentColor ( const GlsColor newColor)
protected

Minimizes calls to glColor when drawing the scale.

Parameters
newColorThe new color to set.

◆ CurrentLineWidth()

void CurrentLineWidth ( const float &  newLineWidth)
protected

Minimizes calls to glLineWidth when drawing the scale.

Parameters
newLineWidthThe new line width to set.

◆ DeconflictTicks() [1/2]

bool DeconflictTicks ( )
inline

Gets the tick deconfliction state for this scale

Returns
Whether or not tick deconfliction is enabled

◆ DeconflictTicks() [2/2]

void DeconflictTicks ( const bool &  val)

Sets the tick deconfliction state for this scale

Parameters
valWether or not to enable tick deconfliction

◆ DisplayList()

GlsDisplayList & DisplayList ( )
inline
Returns
A reference to this object's display list.

◆ Draw()

virtual void Draw ( )
virtual

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

Reimplemented from GLPolygon.

◆ DrawGeometry()

virtual void DrawGeometry ( )
protectedvirtual

Calculates current tick mark locations and performs OpenGL drawing commands

◆ DrawScale()

void DrawScale ( int  i,
float  haloLength,
float  haloThickness 
)
protected

Calculates and draws a single scale using the given halo length and thickness

Parameters
iThe index of the scale to draw
haloLengthThe length of the halo
haloThicknessThe thickness of the halo

◆ GetCppInterfaceDescription()

virtual InterfaceListType * GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

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

Parameters
addToThisListIf 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.

◆ GetCppInterfaceDescriptionFree()

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters
arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from DisplayObject.

◆ GetScale()

void GetScale ( int  index,
GlsLinearScaleData data 
)

Gets the data for one of the scales

Parameters
indexZero based index of the scale to get
dataThe GlsLinearScaleData structure to fill

◆ HaloColor() [1/2]

GlsColor HaloColor ( )
inline

Gets the halo color for this scale

Returns
The halo color for this scale

◆ HaloColor() [2/2]

void HaloColor ( const GlsColor val)

Sets the halo color for this scale

Parameters
valNew halo color

◆ HaloEnabled() [1/2]

bool HaloEnabled ( )
inline

Gets the halo state for this scale

Returns
Whether or not halo is enabled

◆ HaloEnabled() [2/2]

void HaloEnabled ( const bool &  val)

Sets the halo state for this scale

Parameters
valWether or not to enable halo

◆ HaloWidth() [1/2]

float HaloWidth ( )
inline

Gets the halo width for this scale

Returns
The halo width for this scale

◆ HaloWidth() [2/2]

void HaloWidth ( const float &  val)

Sets the halo width for this scale

Parameters
valNew halo width

◆ Hit()

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
xX coordinate of pick ray start in logical coordinates.
yY coordinate of pick ray start in logical coordinates.
zZ coordinate of pick ray start in logical coordinates.
scaleThe scale factor of the window. Affects picking of outlines. Standard value is 1.0.
directionVectorThe direction of the pick ray.
collisionPointIf 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.

◆ InvalidateGeometry()

void InvalidateGeometry ( )
inline

Causes the display list for this object to be recomputed

◆ PreDraw()

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

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

Parameters
currentCurrent matrices inherited from parent
cullerObject that possibly marks this object for culling

Reimplemented from DisplayObject.

◆ RecomputeVertices()

void RecomputeVertices ( )
protected

Recomputes the object's vertices from its radii

◆ Rotate()

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
origThe point to rotate around
angleThe angle to rotate by, in degrees
axisThe arbitrary axis to rotate the object around

Reimplemented from DisplayObject.

◆ Scale()

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
pxValue of the percentage of scale in x-axis
pyValue of the percentage of scale in y-axis
pzValue of the percentage of scale in z-axis
anchorAnchor from which to scale object relative to
handleBarVertex that is being dragged

Reimplemented from DisplayObject.

◆ SetAvailableAttributes()

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
valueA bitfield specifying which types of attributes to make available.
See also
AvailableAttributesEnum

Reimplemented from DisplayObject.

◆ SetColor()

virtual void SetColor ( const GlsColor color)
virtual

Sets the RGBA color for the object outline

Parameters
colorThe new color

Reimplemented from DisplayObject.

◆ SetScale()

void SetScale ( int  index,
const GlsLinearScaleData data 
)

Initializes data for one of the scales

Parameters
indexZero based index of the scale to set
dataThe data to set

◆ SetValue()

virtual void SetValue ( int  spec,
va_list &  args 
)
virtual

Sets an attribute of this object using variable arguments

Parameters
specA GLS_Initializer tag
argsA variable argument list

Reimplemented from DisplayObject.

◆ TickAnchor() [1/2]

GlsTickAnchor TickAnchor ( )
inline

Gets the tick anchor for this scale

Returns
The tick anchor for this scale

◆ TickAnchor() [2/2]

void TickAnchor ( const GlsTickAnchor  val)

Sets the tick anchor for this scale

Parameters
valNew tick anchor

◆ TickNeeded()

bool TickNeeded ( int  currentLevel,
float  currentOffset 
)
protected

Determines if a tick with the given offset should be drawn or not. If a higher priority scale already has a tick at that level and deconfliction is enabled, then this method will return false

Parameters
currentLevelThe current tick type being considered for drawing.
currentOffsetThe offset of the proposed tick.
Returns
True if the tick should be drawn.

◆ UpdateScaleData()

void UpdateScaleData ( )
protected

Recomputes the object's vertices and its radii

◆ UseScalableLines() [1/2]

bool UseScalableLines ( )
inline

Gets the drawing mode for this scale

Returns
The drawing mode for this scale

◆ UseScalableLines() [2/2]

void UseScalableLines ( const bool &  val)

Sets the drawing mode for this scale

Parameters
valNew drawing mode

Member Data Documentation

◆ _currentColor

GlsColor _currentColor
protected

Stores the current color. Used when calculating a new display list so that redundant glColor calls are not made

◆ _currentColorSet

bool _currentColorSet
protected

True if the current color has been set. Gets reset every time a new display list is recalculated.

◆ _currentLineWidth

float _currentLineWidth
protected

Stores the current line width. Used when calculating a new display list so that redundant glLineWidth calls are not made

◆ _currentLineWidthSet

bool _currentLineWidthSet
protected

True if the current line width has been set. Gets reset every time a new display list is recalculated.

◆ _deconflictTicks

bool _deconflictTicks
protected

True if duplicated tick marks are removed

◆ _displayList

GlsDisplayList _displayList
protected

Stores the scale in a display list for faster drawing

◆ _haloColor

GlsColor _haloColor
protected

Color of the halo

◆ _haloEnabled

bool _haloEnabled
protected

True if haloing is enabled

◆ _haloWidth

float _haloWidth
protected

Width of the halo in logical units

◆ _radii

Vector _radii[2]
protected

Two radius vectors that are used to define the orientation of the scale

◆ _radiiNormalized

Vector _radiiNormalized[2]
protected

Normalized radius vectors, cached because they are needed often

◆ _scale

GlsLinearScaleDataArray _scale
protected

The particulars of each scale

◆ _tickAnchor

GlsTickAnchor _tickAnchor
protected

Anchor to determine where ticks will draw

◆ _useScalableLines

bool _useScalableLines
protected

True if scale is drawn with polygon quads instead of lines


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