GlsCylinder Class Reference

Inheritance diagram for GlsCylinder:

Public Member Functions
	GlsCylinder ()
	GlsCylinder (GlsCylinder &src)
	GlsCylinder (float x, float y, float z)
None	FaceStartAngle (float deg)
float	FaceStartAngle ()
None	FaceEndAngle (float deg)
float	FaceEndAngle ()
None	TopSizeFactor (float size)
float	TopSizeFactor ()
None	BottomSizeFactor (float size)
float	BottomSizeFactor ()
None	Segments (int segments)
int	Segments ()
None	Faces (int faces)
int	Faces ()
None	TopFace (bool top)
bool	TopFace ()
None	BottomFace (bool bottom)
bool	BottomFace ()
None	GetRadii (Vector &r1, Vector &r2, Vector &r3)
None	SetRadii (Vector &r1, Vector &r2, Vector &r3)
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 GlsCylinder *	CastToGlsCylinder (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

Class that encapsulates a GlsCylinder.

Constructor & Destructor Documentation

GlsCylinder() [1/3]

GlsCylinder::GlsCylinder

(

)

Constructor.

Creates a new GlsCylinder object at the origin.

GlsCylinder() [2/3]

GlsCylinder::GlsCylinder

(

GlsCylinder &

src

)

Copy ructor.

Creates a new reference to an existing GlsCylinder.

Parameters

src	The GlsCylinder to reference

GlsCylinder() [3/3]

GlsCylinder::GlsCylinder	(	float	x,
		float	y,
		float	z
	)

Constructor.

Creates a new GlsCylinder object at given coordinates.

Parameters

x	x-coordinate of new GlsCylinder
y	y-coordinate of new GlsCylinder
z	z-coordinate of new GlsCylinder

Member Function Documentation

BottomFace() [1/2]

bool GlsCylinder::BottomFace

(

)

Gets whether or not to draw a bottom face on the cylinder.

Returns

True if the cylinder will draw its bottom face

BottomFace() [2/2]

None GlsCylinder::BottomFace

(

bool

bottom

)

Sets whether or not to draw a bottom face on the cylinder.

Parameters

bottom

True if a bottom face should be drawn on the cylinder

BottomSizeFactor() [1/2]

float GlsCylinder::BottomSizeFactor

(

)

Gets the size factor for the bottom of the cylinder.

Returns

The size factor for the bottom of the cylinder

BottomSizeFactor() [2/2]

None GlsCylinder::BottomSizeFactor

(

float

size

)

Sets the size factor for the bottom of the cylinder.

Parameters

size	The new size factor for the bottom of the cylinder

CastToGlsCylinder()

static GlsCylinder * GlsCylinder::CastToGlsCylinder ( DisplayObject *  obj )

static

Casts a display object to a cylinder.

Parameters

obj	The display object to cast.

FaceEndAngle() [1/2]

float GlsCylinder::FaceEndAngle

(

)

Gets the ending degree value for the cylinder.

Returns

The ending degree value

FaceEndAngle() [2/2]

None GlsCylinder::FaceEndAngle

(

float

deg

)

Sets the ending degree value for the cylinder.

Parameters

deg	The new ending degree value

Faces() [1/2]

int GlsCylinder::Faces

(

)

Gets the number of faces around the cylinder.

Returns

The number of faces around the cylinder

Faces() [2/2]

None GlsCylinder::Faces

(

int

faces

)

Sets the number of faces around the cylinder.

Parameters

faces

The new number of faces around the cylinder

FaceStartAngle() [1/2]

float GlsCylinder::FaceStartAngle

(

)

Gets the starting degree value for the cylinder.

Returns

The starting degree value

FaceStartAngle() [2/2]

None GlsCylinder::FaceStartAngle

(

float

deg

)

Sets the starting degree value for the cylinder.

Parameters

deg	The new starting degree value

GetRadii()

None GlsCylinder::GetRadii	(	Vector &	r1,
		Vector &	r2,
		Vector &	r3
	)

Gets the radii vectors for the cylinder.

Parameters

r1	First radius vector (width)
r2	Second radius vector (height)
r3	Third radius vector (depth)

Segments() [1/2]

int GlsCylinder::Segments

(

)

Gets the number of vertical segments per face.

Returns

The number of vertical segments per face.

Segments() [2/2]

None GlsCylinder::Segments

(

int

segments

)

Sets the number of vertical segments per face.

Parameters

segments

The new number of vertical segments per face

SetRadii()

None GlsCylinder::SetRadii	(	Vector &	r1,
		Vector &	r2,
		Vector &	r3
	)

Sets the radii vectors for the cylinder.

Parameters

r1	First radius vector (width)
r2	Second radius vector (height)
r3	Third radius vector (depth)

TopFace() [1/2]

bool GlsCylinder::TopFace

(

)

Gets whether or not to draw a top face on the cylinder.

Returns

True if the cylinder will draw its top face

TopFace() [2/2]

None GlsCylinder::TopFace

(

bool

top

)

Sets whether or not to draw a top face on the cylinder.

Parameters

top	True if a top face should be drawn on the cylinder

TopSizeFactor() [1/2]

float GlsCylinder::TopSizeFactor

(

)

Gets the size factor for the top of the cylinder.

Returns

The size factor for the top of the cylinder

TopSizeFactor() [2/2]

None GlsCylinder::TopSizeFactor

(

float

size

)

Sets the size factor for the top of the cylinder.

Parameters

size	The new size factor for the top of the cylinder

---

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

• GlsCylinder.i