GlsKnob Class Reference

Inheritance diagram for GlsKnob:

Public Member Functions
	GlsKnob ()
	GlsKnob (DisplayObjectArray *objs)
int	NumDetents ()
None	NumDetents (int &i)
bool	EmitDetentValEvent ()
None	EmitDetentValEvent (bool &b)
bool	EmitPositionValEvent ()
None	EmitPositionValEvent (bool &b)
bool	EmitLimitEvent ()
None	EmitLimitEvent (bool &b)
bool	EmitReleaseEvent ()
None	EmitReleaseEvent (bool &b)
bool	ShowDetentsOnly ()
None	ShowDetentsOnly (bool &b)
bool	ClickSelectsDetent ()
None	ClickSelectsDetent (bool &b)
int	DetentVal ()
None	DetentVal (int &i)
float	PositionVal ()
None	PositionVal (float &f)
int	WhichObject ()
None	WhichObject (int &i)
float	Range ()
None	Range (float &f)
bool	Continuous ()
None	Continuous (bool &b)
float	PositionOfDetent (int &pos)
None	PositionOfDetent (int &pos, float &f)
Public Member Functions inherited from Group
	Group ()
	Group (DisplayObjectArray *objs)
None	Ungroup ()
None	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)
None	InsertObjectAllowDuplicateNames (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)
None	MoveObjectToGroup (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)
None	MoveObjectToGroupAllowDuplicateNames (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)
None	ReorderObject (int oldIndex, int newIndex)
DisplayObjectArray *	GetObjectList ()
DisplayObject *	GetObjectByIndex (int index)
int	Count ()
None	CalculateTextureCoordinates (None)
None	SetGroupLocation (Vertex &v)
None	CalculateBoundingBox ()
int	GetCount ()
Public Member Functions inherited from DisplayObject
bool	isNULL ()
str	GetName ()
str	SetName (str name)
None	SetProtectionMode (DisplayObject::MemberAccess_e mode)
DisplayObject::MemberAccess_e	GetProtectionMode (None)
None	SetLocked (bool val)
bool	GetLocked (None)
bool	GetGenerateMemberVariable ()
None	SetGenerateMemberVariable (bool b)
bool	GetAntiAliasing ()
None	SetAntiAliasing (bool antiAliasing)
bool	GetBlinking ()
None	SetBlinking (bool blinking)
float	GetBlinkRate ()
None	SetBlinkRate (float rate)
int	GetAlphaMode ()
None	SetAlphaMode (int mode)
bool	GetCullBackFaces ()
None	SetCullBackFaces (bool cullFaces)
bool	GetZBufferTestedFlag ()
None	SetZBufferTestedFlag (bool tested)
bool	GetAffectZBufferFlag ()
None	SetAffectZBufferFlag (bool affect)
bool	GetLightingEnabledFlag ()
None	SetLightingEnabledFlag (bool enabled)
DisplayObject::PickableType_e	GetPickMode ()
None	SetPickMode (DisplayObject::PickableType_e mode)
bool	GetVisibilityFlag ()
None	SetVisibilityFlag (bool visible)
PolygonClose_e	GetClosePolygonFlag ()
None	SetClosePolygonFlag (PolygonClose_e closePolygon)
PolygonMode_e	GetPolygonMode ()
None	SetPolygonMode (PolygonMode_e polygonMode)
ShadingType_e	GetShadingMode ()
None	SetShadingMode (ShadingType_e shadingMode)
Vertex	GetLocation ()
None	SetLocation (Vertex loc)
Vertex	GetRotationPoint ()
None	SetRotationPoint (Vertex rotPoint)
GlsMatrixAffine *	GetDcsMatrix ()
None	SetDcsMatrix (GlsMatrixAffine *matrix)
int	GetMaterialIndex ()
None	SetMaterialIndex (int matIndex)
str	GetObjectClassName ()
int	GetTextureIndex ()
None	SetTextureIndex (int texIndex)
TextureMap_e	GetTextureMappingTechnique ()
None	SetTextureMappingTechnique (TextureMap_e mappingTechnique)
bool	GetTextureRepeat ()
None	SetTextureRepeat (bool repeat)
disti::GlsColor	GetBlendingColor ()
None	SetBlendingColor (GlsColor blendColor)
DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()
None	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()
None	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
list	GetTextureCoordinates ()
None	SetTextureCoordinates (list &texVerts)
None	GetTextureCoordinates (VertexArray *texVerts)
None	SetTextureCoordinates (VertexArray &texVerts)
None	GetTexturePoints (VertexArray *texVerts)
None	SetTexturePoints (VertexArray &texVerts)
None	SetTexturePoints (list &texVerts)
list	GetTexturePoints ()
None	GetVertices (VertexArray *verts)
None	SetVertices (VertexArray &verts)
str	GetInitialization ()
None	SetInitialization (str initCode)
str	GetCallbackCode ()
None	SetCallbackCode (str cbCode)
DisplayObject *	DuplicateObject (Document *doc=NULL)
DisplayObject *	TessellateObject ()
DisplayObject *	ExtrudeObject (float amount)
None	RotateObject (float amount, RotationAxis_e axis)
None	TranslateObject (float x, float y, float z)
None	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
None	LineWidth (float width)
float	LineWidth ()
LineStyle_e	LineStyle ()
None	LineStyle (LineStyle_e style)
GlsColor	LineColor ()
None	LineColor (GlsColor color)
GlsColor	FillColor ()
None	FillColor (GlsColor color)
None	GetExtents (Vector &min, Vector &max)
bool	HasUserDefinedAttribute (str attribName)
std::map< str, str >	GetUserDefinedAttributes ()
UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()
str	GetUserDefinedAttributeValue (str attribName)
	typemap (check) str attribName
None	SetUserDefinedAttributeValue (str attribName, str value)
DisplayObject *	GetParent ()
Document *	GetDocument ()
str	AlternateClassName ()
None	AlternateClassName (str name)
str	GetAlternateClassHeaderFile ()
None	SetAlternateClassHeaderFile (str name)
str	GetResources ()
str	GetRuntimeResources (bool recursive)
str	GetAttributeType (str attribName)
str	GetAttributeValuestr (str attribName)
None	SetAttributeValuestr (str attribName, str value)
int	RegisterObserver (str attribName, PyObject *pyfunc)
None	UnregisterObserver (str attribName, int id)
list	GetNormals ()
None	SetNormals (list &normals)
list	GetExtraAttributes ()
DisplayObject *	CloneObject ()
None	CopyProperties (DisplayObject *sourceObj)
None	SetLocation (Vector loc)
GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)
None	CalculateParentBoundingBox ()
None	SetOrigin (Vertex &vert)

Static Public Member Functions
static GlsKnob *	CastToGlsKnob (DisplayObject *obj)
Static Public Member Functions inherited from Group
static Group *	CastToGroup (DisplayObject *obj)

Additional Inherited Members
Public Types inherited from DisplayObject
enum	MemberAccess_e {   PUBLIC ,   PRIVATE ,   PROTECTED }
enum	PickableType_e {   UNPICKABLE ,   FIRST_PICK ,   BEST_PICK ,   ALWAYS_PICK }
enum	PolygonClose_e {   POLY_OPEN ,   POLY_CLOSED }
enum	PolygonMode_e {   POLY_MODE_UNDEFINED ,   POLY_MODE_POINTS ,   POLY_MODE_OUTLINE ,   POLY_MODE_FILLED ,   POLY_MODE_FILL_AND_OUTLINE }
enum	ShadingType_e {   SHADING_FLAT ,   SHADING_GOURAUD }
enum	TextureMap_e {   TEXTURE_MAP_MODULATE ,   TEXTURE_MAP_DECAL ,   TEXTURE_MAP_BLEND ,   TEXTURE_MAP_REPLACE }
enum	TextureFilter_e {   TEXTURE_FILTER_NEAREST ,   TEXTURE_FILTER_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST ,   TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR ,   TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }
enum	TessellateType_e {   TESSELLATE_UNION ,   TESSELLATE_INTERSECT ,   TESSELLATE_DIFFERENCE }
enum	RotationAxis_e {   X_AXIS ,   Y_AXIS ,   Z_AXIS }
enum	LineStyle_e {   SOLID_LINE_STYLE ,   SMALL_DOTTED_LINE_STYLE ,   DOTTED_LINE_STYLE ,   DASHED_LINE_STYLE ,   DOT_DASHED_LINE_STYLE ,   SMALL_DASHED_LINE_STYLE }
enum	AlphaMode_e {   ALPHA_MODE_UNDEFINED ,   ALPHA_MODE_OPAQUE ,   ALPHA_MODE_2_LEVEL ,   ALPHA_MODE_256_LEVEL }
Static Public Attributes inherited from Group
static int	DEFAULT_GROUP_LOCATION = -1
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Plug-in used to create knobs in GL Studio.

Constructor & Destructor Documentation

GlsKnob() [1/2]

GlsKnob::GlsKnob

(

)

Creates an empty knob.

GlsKnob() [2/2]

GlsKnob::GlsKnob

(

DisplayObjectArray *

objs

)

Creates a knob with the given children.

Parameters

objs	objects to be added to the knob

Member Function Documentation

CastToGlsKnob()

static GlsKnob * GlsKnob::CastToGlsKnob ( DisplayObject *  obj )

static

Casts a DisplayObject to a GlsKnob.

If the given object is not a knob, it will return NULL. Should be checked for null after casting.

Parameters

obj	Object to cast

ClickSelectsDetent() [1/2]

bool GlsKnob::ClickSelectsDetent

(

)

Gets whether or not clicking on a detent area will cause the knob to snap to that detent.

Returns

bool true if clicking selects a detent, false otherwise

ClickSelectsDetent() [2/2]

None GlsKnob::ClickSelectsDetent

(

bool &

b

)

Sets whether or not clicking on a detent area should cause the knob to snap to that detent.

Parameters

b	true to snap to detent on click, false to disable snapping on click

Continuous() [1/2]

bool GlsKnob::Continuous

(

)

Gets whether or not the knob is allowed to rotate in either direction for any number of turns.

Returns

bool Returns true if knob is allowed to rotate continuously, false otherwise

Continuous() [2/2]

None GlsKnob::Continuous

(

bool &

b

)

Sets whether or not the knob is allowed to rotate in either direction for any number of turns.

Parameters

b	true to allow knob to rotate continuously, false otherwise

DetentVal() [1/2]

int GlsKnob::DetentVal

(

)

Gets the current detent of the knob.

Returns

int Current detent value

DetentVal() [2/2]

None GlsKnob::DetentVal

(

int &

i

)

Sets the detent of the knob.

Parameters

i	New detent value

EmitDetentValEvent() [1/2]

bool GlsKnob::EmitDetentValEvent

(

)

Gets whether or not DetentVal events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitDetentValEvent() [2/2]

None GlsKnob::EmitDetentValEvent

(

bool &

b

)

Sets whether or not to emit DetentVal events.

Parameters

b	true to emit the event, false to not emit the event

EmitLimitEvent() [1/2]

bool GlsKnob::EmitLimitEvent

(

)

Gets whether or not Limit events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitLimitEvent() [2/2]

None GlsKnob::EmitLimitEvent

(

bool &

b

)

Sets whether or not to emit Limit events.

Parameters

b	true to emit the event, false to not emit the event

EmitPositionValEvent() [1/2]

bool GlsKnob::EmitPositionValEvent

(

)

Gets whether or not PositionVal events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitPositionValEvent() [2/2]

None GlsKnob::EmitPositionValEvent

(

bool &

b

)

Sets whether or not to emit PositionVal events.

Parameters

b	true to emit the event, false to not emit the event

EmitReleaseEvent() [1/2]

bool GlsKnob::EmitReleaseEvent

(

)

Gets whether or not Release events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitReleaseEvent() [2/2]

None GlsKnob::EmitReleaseEvent

(

bool &

b

)

Sets whether or not to emit Release events.

Parameters

b	true to emit the event, false to not emit the event

NumDetents() [1/2]

int GlsKnob::NumDetents

(

)

Gets the number of detents on the knob.

Returns

int Number of detents

NumDetents() [2/2]

None GlsKnob::NumDetents

(

int &

i

)

Sets the number of detents on the knob.

Parameters

i	New number of detents

PositionOfDetent() [1/2]

float GlsKnob::PositionOfDetent

(

int &

pos

)

Gets the position of the specified detent.

Returns

float Position of detent

PositionOfDetent() [2/2]

None GlsKnob::PositionOfDetent	(	int &	pos,
		float &	f
	)

Sets the position of the specified detent.

Parameters

pos	Detent to modify
f	New position for detent

PositionVal() [1/2]

float GlsKnob::PositionVal

(

)

Gets the current position of the knob.

Returns

float Current position value

PositionVal() [2/2]

None GlsKnob::PositionVal

(

float &

f

)

Sets the position of the knob.

Parameters

f	New position value

Range() [1/2]

float GlsKnob::Range

(

)

Gets the range of rotation of the knob.

Returns

float Current rotation range in degrees

Range() [2/2]

None GlsKnob::Range

(

float &

f

)

Sets the range of rotation of the knob.

Parameters

f	New rotation range in degrees

ShowDetentsOnly() [1/2]

bool GlsKnob::ShowDetentsOnly

(

)

Gets whether or not the knob will only align with detents.

Returns

bool true if only aligns with detents, false if allowed to align with intermediate values

ShowDetentsOnly() [2/2]

None GlsKnob::ShowDetentsOnly

(

bool &

b

)

Sets whether or not the knob will only align with detents.

Parameters

b	true to only align with detents, false if allowed to align with intermediate values

WhichObject() [1/2]

int GlsKnob::WhichObject

(

)

Gets the index of the knob geometry object.

Returns

int Current knob geometry index

WhichObject() [2/2]

None GlsKnob::WhichObject

(

int &

i

)

Sets the index of the knob geometry object.

Parameters

i	New knob geometry index

---

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

• GlsKnob.i