GlsThumbWheel Class Reference

Inheritance diagram for GlsThumbWheel:

Public Member Functions
	GlsThumbWheel ()
	GlsThumbWheel (GlsThumbWheel &src)
	GlsThumbWheel (DisplayObjectArray *objs)
bool	ContinuousDrag ()
None	ContinuousDrag (bool wrap)
bool	EmitDetentValEvent ()
None	EmitDetentValEvent (bool emitEvent)
bool	EmitLimitEvent ()
None	EmitLimitEvent (bool emitEvent)
bool	EmitReleaseEvent ()
None	EmitReleaseEvent (bool emitEvent)
int	InitialVal ()
None	InitialVal (int detent)
int	NumberOfDetents ()
None	NumberOfDetents (int detents)
int	SoundIndex ()
None	SoundIndex (int index)
int	WhichObjectOdometer ()
None	WhichObjectOdometer (int index)
int	WhichObjectThumbWheel ()
None	WhichObjectThumbWheel (int index)
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 GlsThumbWheel *	CastToGlsThumbWheel (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

Python extension used to modify and create GlsThumbWheel editor objects.

Constructor & Destructor Documentation

GlsThumbWheel() [1/3]

GlsThumbWheel::GlsThumbWheel

(

)

default ructor

GlsThumbWheel() [2/3]

GlsThumbWheel::GlsThumbWheel

(

GlsThumbWheel &

src

)

copy ructor

GlsThumbWheel() [3/3]

GlsThumbWheel::GlsThumbWheel

(

DisplayObjectArray *

objs

)

Convert-to-GlsThumbWheel ructor.

Parameters

objs	Array of display objects to be combined into the Thumb Wheel

Member Function Documentation

CastToGlsThumbWheel()

static GlsThumbWheel * GlsThumbWheel::CastToGlsThumbWheel ( DisplayObject *  obj )

static

Casts the Display Object as a GlsThumbWheel NOTE: perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters

obj	objects to cast

Returns

GlsThumbWheel the GlsThumbWheel

Exceptions

CEIException

ContinuousDrag() [1/2]

bool GlsThumbWheel::ContinuousDrag

(

)

Gets the wheel wrap flag.

Returns

If the thumb wheel will wrap around when a limit is reached.

ContinuousDrag() [2/2]

None GlsThumbWheel::ContinuousDrag

(

bool

wrap

)

Sets the wheel wrap flag.

Parameters

wrap	True if the thumb wheel should wrap around when a limit is reached.

EmitDetentValEvent() [1/2]

bool GlsThumbWheel::EmitDetentValEvent

(

)

Gets the emit event on value change flag.

Returns

Whether or not an event is emitted when the wheel value changes.

EmitDetentValEvent() [2/2]

None GlsThumbWheel::EmitDetentValEvent

(

bool

emitEvent

)

Sets the emit event on value change flag.

Parameters

emitEvent

True if an event should be emitted when the wheel value changes.

EmitLimitEvent() [1/2]

bool GlsThumbWheel::EmitLimitEvent

(

)

Gets the emit event on limit flag.

Returns

Whether or not an event is emitted when a limit is reached.

EmitLimitEvent() [2/2]

None GlsThumbWheel::EmitLimitEvent

(

bool

emitEvent

)

Sets the emit event on limit flag.

Parameters

emitEvent

True if an event should be emitted when a limit is reached.

EmitReleaseEvent() [1/2]

bool GlsThumbWheel::EmitReleaseEvent

(

)

Gets the emit event on defocus flag.

Returns

Whether or not an event is emitted when the wheel loses focus.

EmitReleaseEvent() [2/2]

None GlsThumbWheel::EmitReleaseEvent

(

bool

emitEvent

)

Sets the emit event on defocus flag.

Parameters

emitEvent

True if an event should be emitted when the wheel loses focus.

InitialVal() [1/2]

int GlsThumbWheel::InitialVal

(

)

Gets the initial value.

Returns

The initial value of the wheel.

InitialVal() [2/2]

None GlsThumbWheel::InitialVal

(

int

detent

)

Sets the initial value.

Parameters

detent

The new initial value of the wheel.

NumberOfDetents() [1/2]

int GlsThumbWheel::NumberOfDetents

(

)

Gets the number of detents.

Returns

The number of detents on the wheel.

NumberOfDetents() [2/2]

None GlsThumbWheel::NumberOfDetents

(

int

detents

)

Sets the number of detents.

Parameters

detents

The new number of detents on the wheel.

SoundIndex() [1/2]

int GlsThumbWheel::SoundIndex

(

)

Gets the index into the sound list.

Returns

The index of the sound to play when this wheel's value changes.

SoundIndex() [2/2]

None GlsThumbWheel::SoundIndex

(

int

index

)

Sets the index into the sound list.

Parameters

index

The new index of the sound to play when this wheel's value changes.

WhichObjectOdometer() [1/2]

int GlsThumbWheel::WhichObjectOdometer

(

)

Gets the odometer index.

Returns

The object index in the group to be the odometer (if there is one).

WhichObjectOdometer() [2/2]

None GlsThumbWheel::WhichObjectOdometer

(

int

index

)

Sets the odometer index.

Parameters

index

The new object index in the group to be the odometer.

WhichObjectThumbWheel() [1/2]

int GlsThumbWheel::WhichObjectThumbWheel

(

)

Gets the thumbwheel index.

Returns

The object index in the group to be the thumbwheel.

WhichObjectThumbWheel() [2/2]

None GlsThumbWheel::WhichObjectThumbWheel

(

int

index

)

Sets the thumbwheel index.

Parameters

index

The new object index in the group to be the thumbwheel.

---

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

• GlsThumbWheel.i