GlsNinePatch Class Reference

Inheritance diagram for GlsNinePatch:

Public Types
enum	Edge {   FIRST = 0 ,   LEFT = 0 ,   RIGHT = 1 ,   TOP = 2 ,   BOTTOM = 3 ,   COUNT = 4 }
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
	GlsNinePatch ()
None	TextureEdge (Edge index, float value)
None	VertexEdge (Edge index, float value)
float	TextureEdge (Edge index)
float	VertexEdge (Edge index)
bool	CenterVisible ()
None	CenterVisible (bool value)
None	WidthVector (Vector &v)
None	HeightVector (Vector &v)
Vector	WidthVector ()
Vector	HeightVector ()
None	TextureBLC (float x, float y)
None	TextureTRC (float x, float y)
Vector	TextureBLC ()
Vector	TextureTRC ()
None	Height (float &value)
None	Width (float &value)
float	Height ()
float	Width ()
None	GetPatchVerts (VertexArray *va)
None	GetPatchTex (VectorArray *va)
Rect3D	GetChildRect ()
Public Member Functions inherited from GLPolygon
	GLPolygon (VertexArray &vertices)
	GLPolygon (VertexArray &vertices, Vector &location)
	GLPolygon (list vertices)
	GLPolygon (list vertices, Vector &location)
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 GlsNinePatch *	CastToGlsNinePatch (DisplayObject *obj)
Static Public Member Functions inherited from GLPolygon
static GLPolygon *	CastToGLPolygon (DisplayObject *obj)

Additional Inherited Members
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Plug-in used to create nine patches in Glstudio.

Member Enumeration Documentation

Edge

enum GlsNinePatch::Edge

Enumerator
FIRST	First (left) edge of the GlsNinePatch.
LEFT	Left edge of the GlsNinePatch.
RIGHT	Right edge of the GlsNinePatch.
TOP	Top edge of the GlsNinePatch.
BOTTOM	Bottom edge of the GlsNinePatch.
COUNT

Constructor & Destructor Documentation

GlsNinePatch()

GlsNinePatch::GlsNinePatch

(

)

Creates a nine patch.

Member Function Documentation

CastToGlsNinePatch()

static GlsNinePatch * GlsNinePatch::CastToGlsNinePatch ( DisplayObject *  obj )

static

Casts the Display Object as a GlsNinePatch.

Note

perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters

obj	object to cast

Returns

GlsNinePatch the GlsNinePatch

Exceptions

CEIException

CenterVisible() [1/2]

bool GlsNinePatch::CenterVisible

(

)

Returns whether the center of the nine patch is visible.

Returns

a boolean representing visible (true) or not visible (false)

CenterVisible() [2/2]

None GlsNinePatch::CenterVisible

(

bool

value

)

Sets the center visibility.

Parameters

value

center visible (true) or not (false)

GetChildRect()

Rect3D GlsNinePatch::GetChildRect

(

)

Gets the "child" rectangle.

The child rectangle refers to the inner rectangle of the nine patch, which is where normal content would be drawn.

Returns

A Rect3D with the "blc," "brc," and "trc" set

GetPatchTex()

None GlsNinePatch::GetPatchTex

(

VectorArray *

va

)

Returns a pointer to the texture points.

Parameters

va	A returned pointer to the texture points.

GetPatchVerts()

None GlsNinePatch::GetPatchVerts

(

VertexArray *

va

)

Returns a pointer to the patch vertices.

Parameters

va	A returned pointer to the patch vertices.

Height() [1/2]

float GlsNinePatch::Height

(

)

Returns the height.

Returns

a float representing the height

Height() [2/2]

None GlsNinePatch::Height

(

float &

value

)

Sets the height.

Parameters

value

value to use for height

HeightVector() [1/2]

Vector GlsNinePatch::HeightVector

(

)

Gets the height vector.

Returns

the height vector

HeightVector() [2/2]

None GlsNinePatch::HeightVector

(

Vector &

v

)

Sets the height vector.

Parameters

v	vector to use for height

TextureBLC() [1/2]

Vector GlsNinePatch::TextureBLC

(

)

Gets the texture bottom left corner vector.

Returns

the bottom left corner vector

TextureBLC() [2/2]

None GlsNinePatch::TextureBLC	(	float	x,
		float	y
	)

Sets the texture bottom left corner.

Parameters

x	x value
y	y value

TextureEdge() [1/2]

float GlsNinePatch::TextureEdge

(

Edge

index

)

Gets the texture edge value for the given Edge.

Parameters

index

The Edge value representing which edge to retrieve

Returns

a pointer to the texture points

TextureEdge() [2/2]

None GlsNinePatch::TextureEdge	(	Edge	index,
		float	value
	)

Sets the texture edge value for the given Edge.

Parameters

index	The Edge value representing which edge to change
value	new value for edge

TextureTRC() [1/2]

Vector GlsNinePatch::TextureTRC

(

)

Gets the texture top right corner vector.

Returns

the top right corner vector

TextureTRC() [2/2]

None GlsNinePatch::TextureTRC	(	float	x,
		float	y
	)

Sets the texture top right corner.

Parameters

x	x value
y	y value

VertexEdge() [1/2]

float GlsNinePatch::VertexEdge

(

Edge

index

)

Gets the vertex edge value for the given Edge.

Parameters

index

The Edge value representing which edge to retrieve

Returns

a pointer to the texture points

VertexEdge() [2/2]

None GlsNinePatch::VertexEdge	(	Edge	index,
		float	value
	)

Sets the vertex edge value for the given Edge.

Parameters

index	The Edge value representing which edge to change
value	new value for edge

Width() [1/2]

float GlsNinePatch::Width

(

)

Returns the width.

Returns

a float representing the width

Width() [2/2]

None GlsNinePatch::Width

(

float &

value

)

Sets the width.

Parameters

value

value to use for width

WidthVector() [1/2]

Vector GlsNinePatch::WidthVector

(

)

Gets the width vector.

Returns

the width vector

WidthVector() [2/2]

None GlsNinePatch::WidthVector

(

Vector &

v

)

Sets the width vector.

Parameters

v	vector to use for width

---

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

• GlsNinePatch.i