#include <gls_knob.h>

Inheritance diagram for GlsKnob:

Public Types
typedef Group	_BaseClass
	Deprecated typedef for the base class.

typedef Group	BaseClass
	Typedef for the base class.

Public Types inherited from Group
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
void	EmitDetentValEvent (const bool &value)

bool	EmitDetentValEvent ()

void	EmitPositionValEvent (const bool &value)

bool	EmitPositionValEvent ()

void	EmitLimitEvent (const bool &value)

bool	EmitLimitEvent ()

void	EmitReleaseEvent (const bool &value)

bool	EmitReleaseEvent ()

	GlsKnob (bool generateInstance=false)

	GlsKnob (const GlsKnob &that, const bool generateNames)

virtual	~GlsKnob ()

virtual void	SetAvailableAttributes (unsigned int value) DISTI_METHOD_OVERRIDE

virtual DisplayObject *	CloneObject (bool generateNames=false) DISTI_METHOD_OVERRIDE

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

virtual void	Draw () DISTI_METHOD_OVERRIDE

virtual void	CopyProperties (DisplayObject *src) DISTI_METHOD_OVERRIDE

virtual InterfaceListType *	GetCppInterfaceDescription (InterfaceListType *addToThisList=NULL) DISTI_METHOD_OVERRIDE

virtual void	GetCppInterfaceDescriptionFree (InterfaceListType *array) DISTI_METHOD_OVERRIDE

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

DisplayObject *	handle (DisplayEvent *ev) DISTI_METHOD_OVERRIDE

void	ShowDetentsOnly (const bool &value)

bool	ShowDetentsOnly ()

void	ClickSelectsDetent (const bool &value)

bool	ClickSelectsDetent ()

virtual void	DetentVal (const int &value)

virtual int	DetentVal ()

virtual void	PositionVal (const float &value)

virtual float	PositionVal ()

virtual void	WhichObject (const int &value)

virtual int	WhichObject ()

Public Member Functions inherited from Group
virtual InterfaceListType *	GetCppInterfaceDescription (InterfaceListType *addToThisList=NULL) override

virtual void	GetCppInterfaceDescriptionFree (InterfaceListType *array) override

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

void	PerformGroupCullCheck (bool mode)

bool	CullTestChildren () const

void	CullTestChildren (bool mode)

unsigned int	Count () const

DisplayObjectPtr	operator[] (unsigned int index)

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

DisplayObject *	FirstObject ()

DisplayObject *	LastObject ()

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	SetAvailableAttributes (unsigned int value) override

virtual DisplayObject *	CloneObject (bool generateNames=false) override

virtual void	CopyGeometry (DisplayObject *src) override

virtual void	CopyProperties (DisplayObject *src) override

virtual void	Draw () override

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

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

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

virtual void	Parent (DisplayFrame *par) override

void	SetPainter (GlsPainter *painter) override

virtual void	CalculateBoundingBox ()

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	TranslateVertices (float transAmount[])

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

virtual void	Scale (float scale_x, float scale_y)

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

virtual void	LineWidth (float width) override

virtual float	LineWidth () override

virtual void	LineStipplePattern (int pattern) override

virtual int	LineStipplePattern () override

virtual void	LineStippleMultiplier (int mult) override

virtual int	LineStippleMultiplier () override

virtual int	PolygonMode () override

virtual void	PolygonMode (int mode) override

virtual void	PolygonEnd (const int mode) override

virtual int	PolygonEnd () override

virtual void	Shading (const int mode) override

virtual int	Shading () override

virtual void	DepthTest (unsigned char mode) override

virtual int	DepthTest () override

virtual void	AntiAlias (bool mode) override

virtual bool	AntiAlias () override

virtual void	AlphaMode (int mode) override

virtual int	AlphaMode () override

virtual void	CullBackFace (const bool mode) override

virtual bool	CullBackFace () override

virtual bool	LightingEnabled () override

virtual void	LightingEnabled (bool lighting) override

virtual void	SetBlendColor (const GlsColor &color) override

virtual GlsColor	GetBlendColor () override

virtual void	SetColor (const GlsColor &color) override

virtual GlsColor	GetColor () override

virtual void	SetFillColor (const GlsColor &color) override

virtual GlsColor	GetFillColor () override

virtual void	TextureRepeat (const int rep) override

virtual void	TextureMappingTechnique (const int map) override

virtual int	TextureMappingTechnique () override

virtual void	TextureMinificationFilter (const int filter) override

virtual int	TextureMinificationFilter () override

virtual void	TextureMagnificationFilter (const int filter) override

virtual int	TextureMagnificationFilter () override

virtual void	Calculate (double time) override

CompatabilityListItem *	First ()

CompatabilityListItem *	Last ()

virtual void	Parent (DisplayFrame *par)

DisplayFrame *	Parent () const

virtual const Vertex &	Location () const

virtual void	Location (const Vertex &v)

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

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)

virtual void	SetBlendColor (const GlsColor &color)

void	SetBlendColor (unsigned char color[])

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

void	GetBlendColor (unsigned char color[])

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

virtual GlsColor	GetBlendColor ()

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

void	GetColor (unsigned char c4[])

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

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)

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

void	GetFillColor (unsigned char c4[])

virtual GlsColor	GetFillColor ()

virtual bool	TextureRepeat ()

virtual void	TextureRepeat (const int rep)

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)

DistiAttribDict &	Attributes ()

const DistiAttribDict &	Attributes () 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 Vector &	BoundingVolumeCenter () const

void	BoundingVolumeCenter (const Vector &center)

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

float	BoundingVolumeRadius () const

void	BoundingVolumeRadius (float radius)

virtual void	Calculate (double time)

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

virtual void	CalculateParentBoundingBox ()

virtual void	CalculateTextureCoordinates ()

bool	GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)

CallbackMethodCallerBase *	CallbackCaller () const

void	CallbackCaller (CallbackMethodCallerBase *cb)

virtual void	GetCenter (Vector &center)

virtual DisplayObject *	CloneObject (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 InterfaceListType *	GetCppInterfaceDescription (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)

GlsMatrixType &	DcsMatrix ()

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 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	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 DisplayObject *	handle (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 Vertex &	Location () 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)

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

virtual float	ObjectHeight ()

virtual float	ObjectWidth ()

virtual void	SetOrigin (const Vertex &vert)

virtual void	Parent (DisplayFrame *par)

DisplayFrame *	Parent () const

virtual void	ParentGroup (Group *group)

Group *	ParentGroup () const

virtual DisplayObject *	Pick3D (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)

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

void	RestoreLighting ()

void	RestoreLineStyle ()

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)

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

Vector *	TextureCoordinates ()

Vector *	GetTextureCoordinates ()

virtual int	TextureIndex ()

virtual void	TextureIndex (int textureIndex)

virtual Vector *	GetTexturePoints ()

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 Vertex *	Vertices ()

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 GlsPainter *	GetPainter ()

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 DisplayObject *	CreateInstance ()

Static Public Member Functions inherited from Group
static DisplayObject *	CreateInstance ()

Static Public Member Functions inherited from DisplayObject
static InterfaceListType *	StaticGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)

static void	UseManualBlinkElapsedTime (bool useManualTime)

static void	SetManualBlinkElapsedTime (double elapsedTime)

Public Attributes
float	_angleRange
	In degrees.

int	_numDetents
	Number of detents, snap points of the knob.

DynamicArray< float >	_detentPositions
	Range 0-100.

float	_positionVal
	Current knob position.

bool	_continuous
	If true, the knob can spin all the way around.

int	_whichObject
	The object index in the group to be the knob.

float	_startAngle
	An angle offset from the begining position.

bool	_emitDetentValEvent
	If true, will emit an event when snapping to a detent.

bool	_emitPositionValEvent
	If true, will emit an event when the position is changed.

Public Attributes inherited from Group
DynamicArray< CompatabilityListItem >	_compatList
	Used for GL Studio 2.1 compatibility only.

Protected Member Functions
float	CalcRotationAngle ()

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)

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 Vertex &	LastDrawMatrixLocation ()

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
bool	_showDetentsOnly
	If true, knob will only rotate to exact detents, nothing in between.

bool	_clickSelectsDetent
	If true, clicking on a detent will snap the knob to that detent.

bool	_emitLimitEvent
	If true, an event will be emitted when the knob reaches its upper or lower limit.

bool	_emitReleaseEvent
	If true, an event will be emitted when the knob is released (mouse up).

int	_initialDetentVal
	Stores the initial detent position based on the starting rotation.

float	_mouseDownoX
	X position of the last mouse down in logical coordinates.

float	_mouseDownoY
	Y position of the last mouse down in logical coordinates.

float	_mouseDownoZ
	Z position of the last mouse down in logical coordinates.

Vector	_mouseDownDirectionVector
	Unused, kept for backward compatibility.

float	_mouseDownAngle
	Rotation angle of the knob when the mouse was pressed.

float	_mouseLastAngle
	The rotation angle of the knob on the previous frame.

bool	_atCwStop
	If true, the knob has reached its clockwise most position.

bool	_atCcwStop
	If true, the knob has reached its counter clockwise most position.

bool	_sideMode
	If true, the knob is being viewed at or almost side on.

bool	_mouseWasDown
	If true, the mouse was clicked on a previous frame.

unsigned int	_currentCursor
	The current cursor used for interaction. Any other cursors are ignored while interacting.

Protected Attributes inherited from Group
DisplayObjectArray	_objects
	The objects contained in this group.

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	GlsKnobEditor

Detailed Description

Runtime implementation of a knob

Constructor & Destructor Documentation

◆ GlsKnob() [1/2]

GlsKnob ( bool generateInstance = false )

Create a new GlsKnob.

Parameters

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

◆ GlsKnob() [2/2]

GlsKnob	(	const GlsKnob &	that,
		const bool	generateNames
	)

Copy constructor

Parameters

that	The object to copy from.
generateNames	Whether or not to generate an instance name.

◆ ~GlsKnob()

virtual ~GlsKnob ( )

virtual

Destroy a GlsKnob object

Member Function Documentation

◆ CalcRotationAngle()

float CalcRotationAngle ( )

protected

Returns: The current rotation of the knob in degrees.

◆ ClickSelectsDetent() [1/2]

bool ClickSelectsDetent ( )

inline

Returns: The value of the ClickSelectsDetent property.

◆ ClickSelectsDetent() [2/2]

void ClickSelectsDetent ( const bool & value )

inline

Sets the value of the ClickSelectsDetent property.

Parameters

value The new value to set.

◆ 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

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.

◆ 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

src	The object to copy properties from

Reimplemented from Group.

◆ CreateInstance()

static DisplayObject * CreateInstance ( )

static

Returns: A pointer to a new GlsKnob object.

◆ DetentVal() [1/2]

virtual int DetentVal ( )

virtual

Returns the nearest detent for the knob's current poistion.

Returns: Nearest detent, first detent == 1

◆ DetentVal() [2/2]

virtual void DetentVal ( const int & value )

virtual

Moves the knob to the specified detent Sets the detent value

Parameters

value Desired detent, first detent == 1

◆ Draw()

virtual void Draw ( )

virtual

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

Reimplemented from Group.

◆ EmitDetentValEvent() [1/2]

bool EmitDetentValEvent ( )

inline

Returns: Whether object should emit the DeventVal event.

◆ EmitDetentValEvent() [2/2]

void EmitDetentValEvent ( const bool & value )

inline

Set if object should emit the DeventVal event.

Parameters

value The new flag to set.

◆ EmitLimitEvent() [1/2]

bool EmitLimitEvent ( )

inline

Returns: Whether object should emit the Limit event.

◆ EmitLimitEvent() [2/2]

void EmitLimitEvent ( const bool & value )

inline

Set if object should emit the Limit event.

Parameters

value The new flag to set.

◆ EmitPositionValEvent() [1/2]

bool EmitPositionValEvent ( )

inline

Returns: Whether object should emit the PositionVal event.

◆ EmitPositionValEvent() [2/2]

void EmitPositionValEvent ( const bool & value )

inline

Set if object should emit the PositionVal event.

Parameters

value The new flag to set.

◆ EmitReleaseEvent() [1/2]

bool EmitReleaseEvent ( )

inline

Returns: Whether object should emit the Release event.

◆ EmitReleaseEvent() [2/2]

void EmitReleaseEvent ( const bool & value )

inline

Set if object should emit the Release event.

Parameters

value The new flag to set.

◆ GetCppInterfaceDescription()

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.

◆ GetCppInterfaceDescriptionFree()

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.

◆ handle()

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.

◆ PositionVal() [1/2]

virtual float PositionVal ( )

virtual

Returns the current position of the knob (0.0 - 100.0)

Returns: Current knob position (0.0 - 100.0)

◆ PositionVal() [2/2]

virtual void PositionVal ( const float & value )

virtual

Sets current position of the knob (0.0 - 100.0)

Parameters

value New position of the knob (0.0 - 100.0)

◆ PreDraw()

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.

◆ 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

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

See also: AvailableAttributesEnum

Reimplemented from Group.

◆ SetValue()

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.

◆ ShowDetentsOnly() [1/2]

bool ShowDetentsOnly ( )

inline

Returns: The value of the ShowDetentsOnly property.

◆ ShowDetentsOnly() [2/2]

void ShowDetentsOnly ( const bool & value )

Set the value of the ShowDetentsOnly property.

Parameters

value The new value to set.

◆ WhichObject() [1/2]

virtual int WhichObject ( )

virtual

Returns the current knob geometry index value

Returns: Knob geometry index value

◆ WhichObject() [2/2]

virtual void WhichObject ( const int & value )

virtual

Sets the current knob geometry index value

Parameters

value Knob geometry index value

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

gls_knob.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GlsKnob() [1/2]

◆ GlsKnob() [2/2]

◆ ~GlsKnob()

Member Function Documentation

◆ CalcRotationAngle()

◆ ClickSelectsDetent() [1/2]

◆ ClickSelectsDetent() [2/2]

◆ CloneObject()

◆ CopyProperties()

◆ CreateInstance()

◆ DetentVal() [1/2]

◆ DetentVal() [2/2]

◆ Draw()

◆ EmitDetentValEvent() [1/2]

◆ EmitDetentValEvent() [2/2]

◆ EmitLimitEvent() [1/2]

◆ EmitLimitEvent() [2/2]

◆ EmitPositionValEvent() [1/2]

◆ EmitPositionValEvent() [2/2]

◆ EmitReleaseEvent() [1/2]

◆ EmitReleaseEvent() [2/2]

◆ GetCppInterfaceDescription()

◆ GetCppInterfaceDescriptionFree()

◆ handle()

◆ PositionVal() [1/2]

◆ PositionVal() [2/2]

◆ PreDraw()

◆ SetAvailableAttributes()

◆ SetValue()

◆ ShowDetentsOnly() [1/2]

◆ ShowDetentsOnly() [2/2]

◆ WhichObject() [1/2]

◆ WhichObject() [2/2]