Python Script Engine  7.1
GL Studio Editor Python Script API
GlsMovieTexture Class Reference
+ Inheritance diagram for GlsMovieTexture:

Public Member Functions

 GlsMovieTexture ()
 
 GlsMovieTexture (GlsMovieTexture &src)
 
void MovieSource (String s)
 
String MovieSource ()
 
void Loop (bool &should_loop)
 
bool Loop ()
 
void Playing (bool &should_play)
 
bool Playing ()
 
void Paused (bool &should_pause)
 
bool Paused ()
 
void PlayPosition (float &pct)
 
float PlayPosition ()
 
void CurrentAbsoluteFrame (unsigned int &frame)
 
unsigned int CurrentAbsoluteFrame ()
 
void SoundEnabled (bool &soundon)
 
bool SoundEnabled ()
 
int DurationInMS ()
 
- Public Member Functions inherited from GLPolygon
 GLPolygon (VertexArray &vertices)
 
 GLPolygon (VertexArray &vertices, Vector &location)
 
 GLPolygon (std::vector< Vertex > vertices)
 
 GLPolygon (std::vector< Vertex > vertices, Vector &location)
 
- 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 GlsMovieTextureCastToGlsMovieTexture (DisplayObject *obj)
 
- Static Public Member Functions inherited from GLPolygon
static GLPolygonCastToGLPolygon (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

Python extension used to modify and create GlsMovieTexture editor objects.

Constructor & Destructor Documentation

GlsMovieTexture::GlsMovieTexture ( )

Constructor.

Creates a new GlsMovieTexture object.

GlsMovieTexture::GlsMovieTexture ( GlsMovieTexture src)

Copy constructor.

Creates a new reference to an existing GlsMovieTexture.

Parameters
srcThe GlsMovieTexture to reference

Member Function Documentation

static GlsMovieTexture* GlsMovieTexture::CastToGlsMovieTexture ( DisplayObject obj)
static

Casts a display object to a movie texture.

Parameters
objThe display object to cast
void GlsMovieTexture::CurrentAbsoluteFrame ( unsigned int &  frame)

Sets the position of the stream pointer by frame number.

Parameters
frameThe desired stream position frame number
unsigned int GlsMovieTexture::CurrentAbsoluteFrame ( )

Gets the position of the stream pointer by frame number.

Returns
The current stream position frame number
int GlsMovieTexture::DurationInMS ( )

Gets the length of the movie (in milliseconds).

Returns
The duration of the movie
void GlsMovieTexture::Loop ( bool &  should_loop)

Sets the looping state of the movie.

Setting should_loop to True will cause the movie to "rewind" and start playing again when the end is reached.

Parameters
should_loopThe desired looping state
bool GlsMovieTexture::Loop ( )

Gets the looping state of the movie.

Returns
The current looping state
void GlsMovieTexture::MovieSource ( String  s)

Sets the desired video source file.

Parameters
sThe source video filename
String GlsMovieTexture::MovieSource ( )

Gets the video source file.

Returns
The name of the source video file
void GlsMovieTexture::Paused ( bool &  should_pause)

Sets the paused state of the movie.

Setting should_pause to True will pause the movie.

Parameters
should_pauseThe desired pause state
bool GlsMovieTexture::Paused ( )

Gets the paused state of the movie.

Returns
The current pause state
void GlsMovieTexture::Playing ( bool &  should_play)

Sets the playing state of the movie.

Setting should_play to False will stop the movie.

Parameters
should_playThe desired play state
bool GlsMovieTexture::Playing ( )

Gets the playing state of the movie.

Returns
The current play state
void GlsMovieTexture::PlayPosition ( float &  pct)

Sets the position of the stream pointer by percent.

Parameters
pctThe desired stream position (0.0 - 1.0)
float GlsMovieTexture::PlayPosition ( )

Gets the position of the stream pointer by percent.

Returns
The current stream position
void GlsMovieTexture::SoundEnabled ( bool &  soundon)

Sets the audio playback behavior.

Setting soundon to True will enable audio playback.

Parameters
soundonTrue if audio should be played
bool GlsMovieTexture::SoundEnabled ( )

Gets the audio playback behavior.

Returns
True if this movie is playing audio

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