GlsAngularScale Class Reference

Inheritance diagram for GlsAngularScale:

Public Member Functions
	GlsAngularScale ()
None	SetScale (int index, GlsAngularScaleData &data)
None	GetScale (int index, GlsAngularScaleData &data)
None	DeconflictTicks (bool &val)
bool	DeconflictTicks ()
bool	HaloEnabled ()
None	HaloEnabled (bool &val)
float	HaloWidth ()
None	HaloWidth (float &val)
GlsColor	HaloColor ()
None	HaloColor (GlsColor &val)
bool	UseScalableLines ()
None	UseScalableLines (bool &val)
float	Radius ()
None	Radius (float &val)
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 GlsAngularScale *	CastToGlsAngularScale (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::GlsAngularScale

(

)

Constructor.

Creates a new GlsAngularScale.

Member Function Documentation

CastToGlsAngularScale()

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

static

Casts a display object to an angular scale.

Parameters

obj	The display object to cast.

DeconflictTicks() [1/2]

bool GlsAngularScale::DeconflictTicks

(

)

Gets the tick deconfliction state for this scale.

Returns

Whether or not tick deconfliction is enabled

DeconflictTicks() [2/2]

None GlsAngularScale::DeconflictTicks

(

bool &

val

)

Sets the tick deconfliction state for this scale.

Parameters

val	Whether or not to enable tick deconfliction

GetScale()

None GlsAngularScale::GetScale	(	int	index,
		GlsAngularScaleData &	data
	)

Gets data for one of the scales.

Parameters

	index	Zero based index of the scale to get
[out]	data	The GlsAngularScaleData structure to fill

HaloColor() [1/2]

GlsColor GlsAngularScale::HaloColor

(

)

Gets the halo color for this scale.

Returns

The halo color for this scale

HaloColor() [2/2]

None GlsAngularScale::HaloColor

(

GlsColor &

val

)

Sets the halo color for this scale.

Parameters

val	New halo color

HaloEnabled() [1/2]

bool GlsAngularScale::HaloEnabled

(

)

Gets the halo state for this scale.

Returns

Whether or not halo is enabled

HaloEnabled() [2/2]

None GlsAngularScale::HaloEnabled

(

bool &

val

)

Sets the halo state for this scale.

Parameters

val	Whether or not to enable halo

HaloWidth() [1/2]

float GlsAngularScale::HaloWidth

(

)

Gets the halo width for this scale.

Returns

The halo width for this scale

HaloWidth() [2/2]

None GlsAngularScale::HaloWidth

(

float &

val

)

Sets the halo width for this scale.

Parameters

val	New halo width

Radius() [1/2]

float GlsAngularScale::Radius

(

)

Gets the radius for this scale.

Returns

The radius for this scale

Radius() [2/2]

None GlsAngularScale::Radius

(

float &

val

)

Sets the radius for this scale.

Parameters

val	New radius

SetScale()

None GlsAngularScale::SetScale	(	int	index,
		GlsAngularScaleData &	data
	)

Initializes data for one of the scales.

Parameters

index	Zero based index of the scale to set
data	The data to set

UseScalableLines() [1/2]

bool GlsAngularScale::UseScalableLines

(

)

Gets the line drawing mode for this scale.

Returns

The drawing mode for this scale

UseScalableLines() [2/2]

None 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

val	New drawing mode

---

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

• GlsAngularScale.i