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

Public Member Functions

 GlsAngularScale ()
 
void SetScale (int index, GlsAngularScaleData &data)
 
void GetScale (int index, GlsAngularScaleData &data)
 
void DeconflictTicks (bool &val)
 
bool DeconflictTicks ()
 
bool HaloEnabled ()
 
void HaloEnabled (bool &val)
 
float HaloWidth ()
 
void HaloWidth (float &val)
 
glsColor HaloColor ()
 
void HaloColor (glsColor &val)
 
bool UseScalableLines ()
 
void UseScalableLines (bool &val)
 
float Radius ()
 
void Radius (float &val)
 
- 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 ()
 

Static Public Member Functions

static GlsAngularScaleCastToGlsAngularScale (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 DisplayObject
static int TEXTURE_INDEX_NONE = -1
 

Detailed Description

Python extension used to modify and create GlsAngularScale editor objects.

Constructor & Destructor Documentation

GlsAngularScale::GlsAngularScale ( )

Constructor.

Creates a new GlsAngularScale.

Member Function Documentation

static GlsAngularScale* GlsAngularScale::CastToGlsAngularScale ( DisplayObject obj)
static

Casts a display object to an angular scale.

Parameters
objThe display object to cast.
void GlsAngularScale::DeconflictTicks ( bool &  val)

Sets the tick deconfliction state for this scale.

Parameters
valWhether or not to enable tick deconfliction
bool GlsAngularScale::DeconflictTicks ( )

Gets the tick deconfliction state for this scale.

Returns
Whether or not tick deconfliction is enabled
void GlsAngularScale::GetScale ( int  index,
GlsAngularScaleData data 
)

Gets data for one of the scales.

Parameters
indexZero based index of the scale to get
[out]dataThe GlsAngularScaleData structure to fill
glsColor GlsAngularScale::HaloColor ( )

Gets the halo color for this scale.

Returns
The halo color for this scale
void GlsAngularScale::HaloColor ( glsColor val)

Sets the halo color for this scale.

Parameters
valNew halo color
bool GlsAngularScale::HaloEnabled ( )

Gets the halo state for this scale.

Returns
Whether or not halo is enabled
void GlsAngularScale::HaloEnabled ( bool &  val)

Sets the halo state for this scale.

Parameters
valWhether or not to enable halo
float GlsAngularScale::HaloWidth ( )

Gets the halo width for this scale.

Returns
The halo width for this scale
void GlsAngularScale::HaloWidth ( float &  val)

Sets the halo width for this scale.

Parameters
valNew halo width
float GlsAngularScale::Radius ( )

Gets the radius for this scale.

Returns
The radius for this scale
void GlsAngularScale::Radius ( float &  val)

Sets the radius for this scale.

Parameters
valNew radius
void GlsAngularScale::SetScale ( int  index,
GlsAngularScaleData data 
)

Initializes data for one of the scales.

Parameters
indexZero based index of the scale to set
dataThe data to set
bool GlsAngularScale::UseScalableLines ( )

Gets the line drawing mode for this scale.

Returns
The drawing mode for this scale
void GlsAngularScale::UseScalableLines ( bool &  val)

Sets the line drawing mode for this scale.

If this value is True, scale marks are drawn using quads. If False, they are drawn as lines.

Parameters
valNew drawing mode

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