Python Script Engine  8.3
GL Studio Editor Python Script API
GlsSphere Class Reference
+ Inheritance diagram for GlsSphere:

Public Member Functions

 GlsSphere ()
 
 GlsSphere (GlsSphere &src)
 
 GlsSphere (float x, float y, float z)
 
None StackStartAngle (float deg)
 
float StackStartAngle ()
 
None StackEndAngle (float deg)
 
float StackEndAngle ()
 
None SliceStartAngle (float deg)
 
float SliceStartAngle ()
 
None SliceEndAngle (float deg)
 
float SliceEndAngle ()
 
None Slices (int slices)
 
int Slices ()
 
None Stacks (int stacks)
 
int Stacks ()
 
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)
 
GlsMatrixAffineGetDcsMatrix ()
 
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)
 
DisplayObjectDuplicateObject (Document *doc=NULL)
 
DisplayObjectTessellateObject ()
 
DisplayObjectExtrudeObject (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)
 
DisplayObjectGetParent ()
 
DocumentGetDocument ()
 
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 ()
 
DisplayObjectCloneObject ()
 
None CopyProperties (DisplayObject *sourceObj)
 
None SetLocation (Vector loc)
 
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
 
None CalculateParentBoundingBox ()
 
None SetOrigin (Vertex &vert)
 

Static Public Member Functions

static GlsSphereCastToGlsSphere (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 GlsSphere.

Constructor & Destructor Documentation

◆ GlsSphere() [1/3]

GlsSphere::GlsSphere ( )

Constructor.

Creates a new GlsSphere object at the origin.

◆ GlsSphere() [2/3]

GlsSphere::GlsSphere ( GlsSphere src)

Copy ructor.

Creates a new reference to an existing GlsSphere.

Parameters
srcThe GlsSphere to reference

◆ GlsSphere() [3/3]

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

Constructor.

Creates a new GlsSphere object at given coordinates.

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

Member Function Documentation

◆ CastToGlsSphere()

static GlsSphere * GlsSphere::CastToGlsSphere ( DisplayObject obj)
static

Casts a display object to a sphere.

Parameters
objThe display object to cast.

◆ GetRadii()

None GlsSphere::GetRadii ( Vector r1,
Vector r2,
Vector r3 
)

Gets the radii vectors for the sphere.

Parameters
r1First radius vector (width)
r2Second radius vector (height)
r3Third radius vector (depth)

◆ SetRadii()

None GlsSphere::SetRadii ( Vector r1,
Vector r2,
Vector r3 
)

Sets the radii vectors for the sphere.

Parameters
r1First radius vector (width)
r2Second radius vector (height)
r3Third radius vector (depth)

◆ SliceEndAngle() [1/2]

float GlsSphere::SliceEndAngle ( )

Gets the ending degree value for the slices.

Returns
The slice ending degree value

◆ SliceEndAngle() [2/2]

None GlsSphere::SliceEndAngle ( float  deg)

Sets the ending degree value for the slices.

Parameters
degThe new slice ending degree value

◆ Slices() [1/2]

int GlsSphere::Slices ( )

Gets the number of horizontal slices.

Returns
The current number of horizontal slices

◆ Slices() [2/2]

None GlsSphere::Slices ( int  slices)

Sets the number of horizontal slices.

Parameters
slicesThe desired number of horizontal slices

◆ SliceStartAngle() [1/2]

float GlsSphere::SliceStartAngle ( )

Gets the starting degree value for the slices.

Returns
The slice starting degree value

◆ SliceStartAngle() [2/2]

None GlsSphere::SliceStartAngle ( float  deg)

Sets the starting degree value for the slices.

Parameters
degThe new slice starting degree value

◆ StackEndAngle() [1/2]

float GlsSphere::StackEndAngle ( )

Gets the ending degree value for the stacks.

Returns
The stack ending degree value

◆ StackEndAngle() [2/2]

None GlsSphere::StackEndAngle ( float  deg)

Sets the ending degree value for the stacks.

Parameters
degThe new stack ending degree value

◆ Stacks() [1/2]

int GlsSphere::Stacks ( )

Gets the number of vertical stacks.

Returns
The current number of vertical stacks

◆ Stacks() [2/2]

None GlsSphere::Stacks ( int  stacks)

Sets the number of vertical stacks.

Parameters
stacksThe desired number of vertical stacks

◆ StackStartAngle() [1/2]

float GlsSphere::StackStartAngle ( )

Gets the starting degree value for the stacks.

Returns
The stack starting degree value

◆ StackStartAngle() [2/2]

None GlsSphere::StackStartAngle ( float  deg)

Sets the starting degree value for the stacks.

Parameters
degThe new stack starting degree value

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