GlsSwitch Class Reference

Inheritance diagram for GlsSwitch:

Public Types
enum	InputOrientation_e {   INPUT_VERTICAL = 1 ,   INPUT_HORIZONTAL = 2 }
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 }

Public Member Functions
	GlsSwitch ()
	GlsSwitch (DisplayObjectArray *objs)
None	FirstDetentSnapback (bool &value)
bool	FirstDetentSnapback ()
None	LastDetentSnapback (bool &value)
bool	LastDetentSnapback ()
None	EmitDetentValEvent (bool &value)
bool	EmitDetentValEvent ()
None	EmitLimitEvent (bool &value)
bool	EmitLimitEvent ()
None	EmitReleaseEvent (bool &value)
bool	EmitReleaseEvent ()
int	NumDetents ()
DisplayObject *	DetentGeometry (int detent)
DisplayObject *	BackgroundGeometry ()
InputOrientation_e	InputType (None)
None	DetentVal (int &val)
int	DetentVal ()
None	WhichObjectBackground (int &val)
int	WhichObjectBackground ()
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 GlsSwitch *	CastToGlsSwitch (DisplayObject *obj)
Static Public Member Functions inherited from Group
static Group *	CastToGroup (DisplayObject *obj)

Additional Inherited Members
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 GlsSwitch editor objects.

Member Enumeration Documentation

InputOrientation_e

enum GlsSwitch::InputOrientation_e

The orientation of the switch relative to the y axis.

Enumerator
INPUT_VERTICAL
INPUT_HORIZONTAL

Constructor & Destructor Documentation

GlsSwitch() [1/2]

GlsSwitch::GlsSwitch

(

)

Creates an empty switch.

GlsSwitch() [2/2]

GlsSwitch::GlsSwitch

(

DisplayObjectArray *

objs

)

Creates a switch with the given children.

Parameters

objs	objects to be added to the switch

Member Function Documentation

BackgroundGeometry()

DisplayObject * GlsSwitch::BackgroundGeometry

(

)

Returns the geometry specified as the background.

Returns

DisplayObject* Pointer to the geometry, NULL if none is set

CastToGlsSwitch()

static GlsSwitch * GlsSwitch::CastToGlsSwitch ( DisplayObject *  obj )

static

Casts a DisplayObject to a GlsSwitch.

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

Parameters

obj	Object to cast

DetentGeometry()

DisplayObject * GlsSwitch::DetentGeometry

(

int

detent

)

Gets the geometry associated with the given detent.

Parameters

detent

detent value to look up

Returns

DisplayObject* Pointer to the geometry

DetentVal() [1/2]

int GlsSwitch::DetentVal

(

)

Gets the current detent of the switch.

Returns

int Current detent value

DetentVal() [2/2]

None GlsSwitch::DetentVal

(

int &

val

)

Sets the detent of the switch.

Parameters

val	New detent value

EmitDetentValEvent() [1/2]

bool GlsSwitch::EmitDetentValEvent

(

)

Gets whether or not DetentVal events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitDetentValEvent() [2/2]

None GlsSwitch::EmitDetentValEvent

(

bool &

value

)

Sets whether or not to emit DetentVal events.

Parameters

value

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

EmitLimitEvent() [1/2]

bool GlsSwitch::EmitLimitEvent

(

)

Gets whether or not Limit events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitLimitEvent() [2/2]

None GlsSwitch::EmitLimitEvent

(

bool &

value

)

Sets whether or not to emit Limit events.

Parameters

value

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

EmitReleaseEvent() [1/2]

bool GlsSwitch::EmitReleaseEvent

(

)

Gets whether or not Release events are emitted.

Returns

bool true if event will be emitted, false otherwise

EmitReleaseEvent() [2/2]

None GlsSwitch::EmitReleaseEvent

(

bool &

value

)

Sets whether or not to emit Release events.

Parameters

value

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

FirstDetentSnapback() [1/2]

bool GlsSwitch::FirstDetentSnapback

(

)

Gets the current switch snapback behavior for the first detent.

Returns

bool Current snapback value (true=snapback, false=no snapback)

FirstDetentSnapback() [2/2]

None GlsSwitch::FirstDetentSnapback

(

bool &

value

)

Sets the switch snapback behavior for the first detent.

Parameters

value

New snapback value (true=snapback, false=no snapback)

InputType()

InputOrientation_e GlsSwitch::InputType

(

None

)

Calculates if this switch is horizontal or vertical relative to the y axis.

Returns

InputOrientation_e Input orientation enumeration value

LastDetentSnapback() [1/2]

bool GlsSwitch::LastDetentSnapback

(

)

Gets the current switch snapback behavior for the last detent.

Returns

bool Current snapback value (true=snapback, false=no snapback)

LastDetentSnapback() [2/2]

None GlsSwitch::LastDetentSnapback

(

bool &

value

)

Sets the switch snapback behavior for the last detent.

Parameters

value

New snapback value (true=snapback, false=no snapback)

NumDetents()

int GlsSwitch::NumDetents

(

)

Gets the number of detents on the switch.

Returns

int Number of detents

WhichObjectBackground() [1/2]

int GlsSwitch::WhichObjectBackground

(

)

Gets the current background geometry index of the switch.

Returns

int Current background geometry index

WhichObjectBackground() [2/2]

None GlsSwitch::WhichObjectBackground

(

int &

val

)

Sets the background geometry index of the switch.

Parameters

val	New background geometry index

---

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

• GlsSwitch.i