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

Public Types

enum  Movement_t {
  CONSTANT = 0 ,
  SINUSOIDAL = 1
}
 
enum  Route_t {
  DIRECT = 0 ,
  ARC = 1
}
 
- Public Types inherited from GlsEyePoint
enum  FovConstraintType {
  FOV_CONSTRAINT_NONE ,
  FOV_CONSTRAINT_GREATER ,
  FOV_CONSTRAINT_LESS ,
  FOV_CONSTRAINT_EXACTLY
}
 
- 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

 GlsMovingEye ()
 
 GlsMovingEye (GlsMovingEye &src)
 
bool DisableMoveHistory ()
 
None DisableMoveHistory (bool his)
 
bool EmitEvent ()
 
None EmitEvent (bool emit)
 
str LookAtObject ()
 
None LookAtObject (str name)
 
float MaxSpeed ()
 
None MaxSpeed (float speed)
 
Movement_t Movement ()
 
None Movement (Movement_t movementType)
 
Route_t Route ()
 
None Route (Route_t routeType)
 
- Public Member Functions inherited from GlsEyePoint
 GlsEyePoint ()
 
 GlsEyePoint (GlsEyePoint &src)
 
None FOV (float fovDeg)
 
None OtherFOV (float fovDeg)
 
None FovIsHorizontal (bool val)
 
None Orthographic (bool val)
 
None OrthoSize (float val)
 
None OtherOrthoSize (float val)
 
None NearClip (float val)
 
None FarClip (float val)
 
None HorizontalConstraint (FovConstraintType val)
 
None VerticalConstraint (FovConstraintType val)
 
None SetViewVectors (Vector &x, Vector &y, Vector &z)
 
float FOV (None)
 
float OtherFOV (None)
 
bool FovIsHorizontal (None)
 
bool Orthographic (None)
 
float OrthoSize (None)
 
float OtherOrthoSize (None)
 
float NearClip (None)
 
float FarClip (None)
 
FovConstraintType HorizontalConstraint (None)
 
FovConstraintType VerticalConstraint (None)
 
None GetViewVectors (Vector &x, Vector &y, Vector &z)
 
None Orientation (Vector &direction, float roll, Vector &upVector=Vector(0, 1, 0))
 
Vector Direction (None)
 
float Roll (Vector upVector=Vector(0, 1, 0))
 
- 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 GlsMovingEyeCastToGlsMovingEye (DisplayObject *obj)
 
- Static Public Member Functions inherited from GlsEyePoint
static GlsEyePointCastToGlsEyePoint (DisplayObject *obj)
 

Additional Inherited Members

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

Detailed Description

Python extension used to modify and create GlsMovingEye editor objects.

Member Enumeration Documentation

◆ Movement_t

Movement type values.

Enumerator
CONSTANT 
SINUSOIDAL 

◆ Route_t

Route type values.

Enumerator
DIRECT 
ARC 

Constructor & Destructor Documentation

◆ GlsMovingEye() [1/2]

GlsMovingEye::GlsMovingEye ( )

default ructor

◆ GlsMovingEye() [2/2]

GlsMovingEye::GlsMovingEye ( GlsMovingEye src)

copy ructor

Member Function Documentation

◆ CastToGlsMovingEye()

static GlsMovingEye * GlsMovingEye::CastToGlsMovingEye ( DisplayObject obj)
static

Casts the Display Object as a GlsMovingEye NOTE: perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters
objobjects to cast
Returns
GlsMovingEye the GlsMovingEye
Exceptions
CEIException

◆ DisableMoveHistory() [1/2]

bool GlsMovingEye::DisableMoveHistory ( )

Gets the move history disable flag.

Returns
Whether or not the move history is disabled.

◆ DisableMoveHistory() [2/2]

None GlsMovingEye::DisableMoveHistory ( bool  his)

Sets the move history disable flag.

Parameters
hisTrue if the move history should be disabled.

◆ EmitEvent() [1/2]

bool GlsMovingEye::EmitEvent ( )

Gets the event emit flag.

Returns
Whether or not an event is emitted upon completion of a commanded movement.

◆ EmitEvent() [2/2]

None GlsMovingEye::EmitEvent ( bool  emit)

Sets the event emit flag.

Parameters
emitSets whether or not an event is emitted upon completion of a commanded movement.

◆ LookAtObject() [1/2]

str GlsMovingEye::LookAtObject ( )

Gets the look at object name.

Returns
The name of the object that the eyepoint should be always looking at.

◆ LookAtObject() [2/2]

None GlsMovingEye::LookAtObject ( str  name)

Sets the look at object name.

Parameters
nameThe name of the object that the eyepoint should be always looking at.

◆ MaxSpeed() [1/2]

float GlsMovingEye::MaxSpeed ( )

Gets the maximum movement speed.

Returns
The maximum speed in logical units/second which will be used to achive the transition between eyepoints.

◆ MaxSpeed() [2/2]

None GlsMovingEye::MaxSpeed ( float  speed)

Sets the maximum movement speed.

Parameters
speedThe maximum speed in logical units/second which will be used to achive the transition between eyepoints.

◆ Movement() [1/2]

Movement_t GlsMovingEye::Movement ( )

Gets the movement type.

Returns
The type of movement algorithm to use when moving to another eyepoint.

◆ Movement() [2/2]

None GlsMovingEye::Movement ( Movement_t  movementType)

Sets the movement type.

Parameters
movementTypeThe type of movement algorithm to use when moving to another eyepoint.

◆ Route() [1/2]

Route_t GlsMovingEye::Route ( )

Gets the route type.

Returns
The type of route to use when moving to another eyepoint.

◆ Route() [2/2]

None GlsMovingEye::Route ( Route_t  routeType)

Sets the route type.

Parameters
routeTypeThe type of route to use when moving to another eyepoint.

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