Python Script Engine  7.2
GL Studio Editor Python Script API
GlsCylinder Class Reference
+ Inheritance diagram for GlsCylinder:

Public Member Functions

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

Constructor.

Creates a new GlsCylinder object at the origin.

GlsCylinder::GlsCylinder ( GlsCylinder src)

Copy constructor.

Creates a new reference to an existing GlsCylinder.

Parameters
srcThe GlsCylinder to reference
GlsCylinder::GlsCylinder ( float  x,
float  y,
float  z 
)

Constructor.

Creates a new GlsCylinder object at given coordinates.

Parameters
xx-coordinate of new GlsCylinder
yy-coordinate of new GlsCylinder
zz-coordinate of new GlsCylinder

Member Function Documentation

void GlsCylinder::BottomFace ( bool  bottom)

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

Parameters
bottomTrue if a bottom face should be drawn on the cylinder
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
void GlsCylinder::BottomSizeFactor ( float  size)

Sets the size factor for the bottom of the cylinder.

Parameters
sizeThe new size factor for the bottom of the cylinder
float GlsCylinder::BottomSizeFactor ( )

Gets the size factor for the bottom of the cylinder.

Returns
The size factor for the bottom of the cylinder
static GlsCylinder* GlsCylinder::CastToGlsCylinder ( DisplayObject obj)
static

Casts a display object to a cylinder.

Parameters
objThe display object to cast.
void GlsCylinder::FaceEndAngle ( float  deg)

Sets the ending degree value for the cylinder.

Parameters
degThe new ending degree value
float GlsCylinder::FaceEndAngle ( )

Gets the ending degree value for the cylinder.

Returns
The ending degree value
void GlsCylinder::Faces ( unsigned int  faces)

Sets the number of faces around the cylinder.

Parameters
facesThe new number of faces around the cylinder
unsigned int GlsCylinder::Faces ( )

Gets the number of faces around the cylinder.

Returns
The number of faces around the cylinder
void GlsCylinder::FaceStartAngle ( float  deg)

Sets the starting degree value for the cylinder.

Parameters
degThe new starting degree value
float GlsCylinder::FaceStartAngle ( )

Gets the starting degree value for the cylinder.

Returns
The starting degree value
void GlsCylinder::GetRadii ( Vector r1,
Vector r2,
Vector r3 
)

Gets the radii vectors for the cylinder.

Parameters
r1First radius vector (width)
r2Second radius vector (height)
r3Third radius vector (depth)
void GlsCylinder::Segments ( unsigned int  segments)

Sets the number of vertical segments per face.

Parameters
segmentsThe new number of vertical segments per face
unsigned int GlsCylinder::Segments ( )

Gets the number of vertical segments per face.

Returns
The number of vertical segments per face.
void GlsCylinder::SetRadii ( Vector r1,
Vector r2,
Vector r3 
)

Sets the radii vectors for the cylinder.

Parameters
r1First radius vector (width)
r2Second radius vector (height)
r3Third radius vector (depth)
void GlsCylinder::TopFace ( bool  top)

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

Parameters
topTrue if a top face should be drawn on the cylinder
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
void GlsCylinder::TopSizeFactor ( float  size)

Sets the size factor for the top of the cylinder.

Parameters
sizeThe new size factor for the top of the cylinder
float GlsCylinder::TopSizeFactor ( )

Gets the size factor for the top of the cylinder.

Returns
The size factor for the top of the cylinder

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