Python Script Engine  1.0
GL Studio Editor Python Script API
GlsPushButton Class Reference
+ Inheritance diagram for GlsPushButton:

Public Member Functions

 GlsPushButton ()
 GlsPushButton (DisplayObjectArray *objs)
void State (int &state)
int State ()
void Toggle (bool &value)
bool Toggle ()
void WhichObjectPosUp (int &value)
int WhichObjectPosUp ()
void WhichObjectPosDown (int &value)
int WhichObjectPosDown ()
void EmitStateChangeEvent (bool &value)
bool EmitStateChangeEvent ()
- 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)
DisplayObjectArrayGetObjectList ()
DisplayObjectGetObjectByIndex (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)
GlsMatrixAffineGetDcsMatrix ()
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< VectorGetTextureCoordinates ()
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< VectorGetTexturePoints ()
void GetVertices (VertexArray *verts)
void SetVertices (VertexArray &verts)
String GetInitialization ()
void SetInitialization (String initCode)
String GetCallbackCode ()
void SetCallbackCode (String cbCode)
DisplayObjectDuplicateObject (Document *doc=NULL)
DisplayObjectTessellateObject ()
DisplayObjectExtrudeObject (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)
DisplayObjectGetParent ()
DocumentGetDocument ()
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< VectorGetNormals ()
void SetNormals (std::vector< Vector > normals)
std::vector< CustomAttributeInfoGetExtraAttributes ()
DisplayObjectCloneObject ()
void CopyProperties (DisplayObject *sourceObj)
void SetLocation (Vector loc)
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
void CalculateParentBoundingBox ()
void SetOrigin (Vertex &vert)

Static Public Member Functions

static GlsPushButtonCastToGlsPushButton (DisplayObject *obj)
- Static Public Member Functions inherited from Group
static GroupCastToGroup (DisplayObject *obj)

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  MemberAccess_e {
enum  PickableType_e {
enum  PolygonClose_e {
enum  PolygonMode_e {
enum  ShadingType_e {
enum  TextureMap_e {
enum  TextureFilter_e {
enum  TessellateType_e {
enum  RotationAxis_e {
enum  LineStyle_e {
enum  AlphaMode_e {
- Static Public Attributes inherited from Group
- Static Public Attributes inherited from DisplayObject
static int TEXTURE_INDEX_NONE = -1

Detailed Description

Plug-in used to create push buttons in GL Studio.

Constructor & Destructor Documentation

GlsPushButton::GlsPushButton ( )

Creates an empty push button.

GlsPushButton::GlsPushButton ( DisplayObjectArray objs)

Creates a push button with the given children.

objsobjects to be added to the push button

Member Function Documentation

static GlsPushButton* GlsPushButton::CastToGlsPushButton ( DisplayObject obj)

Casts a DisplayObject to a GlsPushButton.

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

objObject to cast
void GlsPushButton::EmitStateChangeEvent ( bool &  value)

Sets whether or not to emit StateChange events.

valuetrue to emit the event, false to not emit the event
bool GlsPushButton::EmitStateChangeEvent ( )

Gets whether or not StateChange events are emitted.

bool true if event will be emitted, false otherwise
void GlsPushButton::State ( int &  state)

Sets the push button state (0=up, 1=down)

stateNew button state (0=up, 1=down)
int GlsPushButton::State ( )

Gets the current push button state (0=up, 1=down)

int Current push button state (0=up, 1=down)
void GlsPushButton::Toggle ( bool &  value)

Sets the push button behavior (true=toggle, false=momentary)

valueNew toggle value (true=toggle, false=momentary)
bool GlsPushButton::Toggle ( )

Gets the current push button behavior (true=toggle, false=momentary)

bool Current push button behavior (true=toggle, false=momentary)
void GlsPushButton::WhichObjectPosDown ( int &  value)

Sets the object index to use for the button down position.

valueNew index for down position
int GlsPushButton::WhichObjectPosDown ( )

Gets the current object index being used for the button down position.

int Current down position index
void GlsPushButton::WhichObjectPosUp ( int &  value)

Sets the object index to use for the button up position.

valueNew index for up position
int GlsPushButton::WhichObjectPosUp ( )

Gets the current object index being used for the button up position.

int Current up position index

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