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)

void	FirstDetentSnapback (bool &value)

bool	FirstDetentSnapback ()

void	LastDetentSnapback (bool &value)

bool	LastDetentSnapback ()

void	EmitDetentValEvent (bool &value)

bool	EmitDetentValEvent ()

void	EmitLimitEvent (bool &value)

bool	EmitLimitEvent ()

void	EmitReleaseEvent (bool &value)

bool	EmitReleaseEvent ()

int	NumDetents ()

DisplayObject *	DetentGeometry (int detent)

DisplayObject *	BackgroundGeometry ()

InputOrientation_e	InputType (void)

void	DetentVal (int &val)

int	DetentVal ()

void	WhichObjectBackground (int &val)

int	WhichObjectBackground ()

Public Member Functions inherited from Group
	Group ()

	Group (DisplayObjectArray *objs)

void	Ungroup ()

void	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	InsertObjectAllowDuplicateNames (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	MoveObjectToGroup (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	MoveObjectToGroupAllowDuplicateNames (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	ReorderObject (unsigned int oldIndex, unsigned int newIndex)

DisplayObjectArray *	GetObjectList ()

DisplayObject *	GetObjectByIndex (unsigned int index)

unsigned int	Count (void)

void	CalculateTextureCoordinates (void)

void	SetGroupLocation (Vertex &v)

void	CalculateBoundingBox ()

unsigned int	GetCount ()

Public Member Functions inherited from DisplayObject
bool	isNULL (void)

String	GetName ()

String	SetName (String name)

void	SetProtectionMode (DisplayObject::MemberAccess_e mode)

DisplayObject::MemberAccess_e	GetProtectionMode (void)

void	SetLocked (bool val)

bool	GetLocked (void)

bool	GetGenerateMemberVariable ()

void	SetGenerateMemberVariable (bool b)

bool	GetAntiAliasing ()

void	SetAntiAliasing (bool antiAliasing)

bool	GetBlinking ()

void	SetBlinking (bool blinking)

float	GetBlinkRate ()

void	SetBlinkRate (float rate)

int	GetAlphaMode ()

void	SetAlphaMode (int mode)

bool	GetCullBackFaces ()

void	SetCullBackFaces (bool cullFaces)

bool	GetZBufferTestedFlag ()

void	SetZBufferTestedFlag (bool tested)

bool	GetAffectZBufferFlag ()

void	SetAffectZBufferFlag (bool affect)

bool	GetLightingEnabledFlag ()

void	SetLightingEnabledFlag (bool enabled)

DisplayObject::PickableType_e	GetPickMode ()

void	SetPickMode (DisplayObject::PickableType_e mode)

bool	GetVisibilityFlag ()

void	SetVisibilityFlag (bool visible)

PolygonClose_e	GetClosePolygonFlag ()

void	SetClosePolygonFlag (PolygonClose_e closePolygon)

PolygonMode_e	GetPolygonMode ()

void	SetPolygonMode (PolygonMode_e polygonMode)

ShadingType_e	GetShadingMode ()

void	SetShadingMode (ShadingType_e shadingMode)

Vertex	GetLocation ()

void	SetLocation (Vertex loc)

Vertex	GetRotationPoint ()

void	SetRotationPoint (Vertex rotPoint)

GlsMatrixAffine *	GetDcsMatrix ()

void	SetDcsMatrix (GlsMatrixAffine *matrix)

int	GetMaterialIndex ()

void	SetMaterialIndex (int matIndex)

String	GetObjectClassName ()

int	GetTextureIndex ()

void	SetTextureIndex (int texIndex)

TextureMap_e	GetTextureMappingTechnique ()

void	SetTextureMappingTechnique (TextureMap_e mappingTechnique)

bool	GetTextureRepeat ()

void	SetTextureRepeat (bool repeat)

disti::GlsColor	GetBlendingColor ()

void	SetBlendingColor (GlsColor blendColor)

DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()

void	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)

DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()

void	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)

std::vector< Vector >	GetTextureCoordinates ()

void	SetTextureCoordinates (std::vector< Vector > &texVerts)

void	GetTextureCoordinates (VertexArray *texVerts)

void	SetTextureCoordinates (VertexArray &texVerts)

void	GetTexturePoints (VertexArray *texVerts)

void	SetTexturePoints (VertexArray &texVerts)

void	SetTexturePoints (std::vector< Vector > &texVerts)

std::vector< Vector >	GetTexturePoints ()

void	GetVertices (VertexArray *verts)

void	SetVertices (VertexArray &verts)

String	GetInitialization ()

void	SetInitialization (String initCode)

String	GetCallbackCode ()

void	SetCallbackCode (String cbCode)

DisplayObject *	DuplicateObject (Document *doc=NULL)

DisplayObject *	TessellateObject ()

DisplayObject *	ExtrudeObject (float amount)

void	RotateObject (float amount, RotationAxis_e axis)

void	TranslateObject (float x, float y, float z)

void	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)

void	LineWidth (float width)

float	LineWidth ()

LineStyle_e	LineStyle ()

void	LineStyle (LineStyle_e style)

GlsColor	LineColor ()

void	LineColor (GlsColor color)

GlsColor	FillColor ()

void	FillColor (GlsColor color)

void	GetExtents (Vector &min, Vector &max)

bool	HasUserDefinedAttribute (String attribName)

std::map< String, String >	GetUserDefinedAttributes ()

String	GetUserDefinedAttributeValue (String attribName)

	typemap (check) String attribName

void	SetUserDefinedAttributeValue (String attribName, String value)

DisplayObject *	GetParent ()

Document *	GetDocument ()

String	AlternateClassName ()

void	AlternateClassName (String name)

String	GetAlternateClassHeaderFile ()

void	SetAlternateClassHeaderFile (String name)

String	GetResources ()

String	GetRuntimeResources (bool recursive)

String	GetAttributeValueString (String attribName)

void	SetAttributeValueString (String attribName, String value)

unsigned int	RegisterObserver (String attribName, PyObject *pyfunc)

void	UnregisterObserver (String attribName, unsigned int id)

std::vector< Vector >	GetNormals ()

void	SetNormals (std::vector< Vector > &normals)

std::vector< CustomAttributeInfo >	GetExtraAttributes ()

DisplayObject *	CloneObject ()

void	CopyProperties (DisplayObject *sourceObj)

void	SetLocation (Vector loc)

GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)

void	CalculateParentBoundingBox ()

void	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

enum GlsSwitch::InputOrientation_e

The orientation of the switch relative to the y axis.

Enumerator
INPUT_VERTICAL
INPUT_HORIZONTAL

Constructor & Destructor Documentation

GlsSwitch::GlsSwitch ( )

Creates an empty switch.

GlsSwitch::GlsSwitch ( DisplayObjectArray * objs )

Creates a switch with the given children.

Parameters

objs	objects to be added to the switch

Member Function Documentation

DisplayObject* GlsSwitch::BackgroundGeometry ( )

Returns the geometry specified as the background.

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

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

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

void GlsSwitch::DetentVal ( int & val )

Sets the detent of the switch.

Parameters

val	New detent value

int GlsSwitch::DetentVal ( )

Gets the current detent of the switch.

Returns: int Current detent value

void 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

bool GlsSwitch::EmitDetentValEvent ( )

Gets whether or not DetentVal events are emitted.

Returns: bool true if event will be emitted, false otherwise

void 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

bool GlsSwitch::EmitLimitEvent ( )

Gets whether or not Limit events are emitted.

Returns: bool true if event will be emitted, false otherwise

void 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

bool GlsSwitch::EmitReleaseEvent ( )

Gets whether or not Release events are emitted.

Returns: bool true if event will be emitted, false otherwise

void GlsSwitch::FirstDetentSnapback ( bool & value )

Sets the switch snapback behavior for the first detent.

Parameters

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

bool GlsSwitch::FirstDetentSnapback ( )

Gets the current switch snapback behavior for the first detent.

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

InputOrientation_e GlsSwitch::InputType ( void )

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

Returns: InputOrientation_e Input orientation enumeration value

void GlsSwitch::LastDetentSnapback ( bool & value )

Sets the switch snapback behavior for the last detent.

Parameters

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

bool GlsSwitch::LastDetentSnapback ( )

Gets the current switch snapback behavior for the last detent.

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

int GlsSwitch::NumDetents ( )

Gets the number of detents on the switch.

Returns: int Number of detents

void GlsSwitch::WhichObjectBackground ( int & val )

Sets the background geometry index of the switch.

Parameters

val	New background geometry index

int GlsSwitch::WhichObjectBackground ( )

Gets the current background geometry index of the switch.

Returns: int Current background geometry index

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

GlsSwitch.i

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation