GlsMovieTexture Class Reference

Inheritance diagram for GlsMovieTexture:

Public Member Functions
	GlsMovieTexture ()
	GlsMovieTexture (GlsMovieTexture &src)
None	MovieSource (str s)
str	MovieSource ()
None	Loop (bool &should_loop)
bool	Loop ()
None	Playing (bool &should_play)
bool	Playing ()
None	Paused (bool &should_pause)
bool	Paused ()
None	PlayPosition (float &pct)
float	PlayPosition ()
None	CurrentAbsoluteFrame (int &frame)
int	CurrentAbsoluteFrame ()
None	SoundEnabled (bool &soundon)
bool	SoundEnabled ()
int	DurationInMS ()
Public Member Functions inherited from GLPolygon
	GLPolygon (VertexArray &vertices)
	GLPolygon (VertexArray &vertices, Vector &location)
	GLPolygon (list vertices)
	GLPolygon (list vertices, Vector &location)
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 GlsMovieTexture *	CastToGlsMovieTexture (DisplayObject *obj)
Static Public Member Functions inherited from GLPolygon
static GLPolygon *	CastToGLPolygon (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() [1/2]

GlsMovieTexture::GlsMovieTexture

(

)

Constructor.

Creates a new GlsMovieTexture object.

GlsMovieTexture() [2/2]

GlsMovieTexture::GlsMovieTexture

(

GlsMovieTexture &

src

)

Copy ructor.

Creates a new reference to an existing GlsMovieTexture.

Parameters

src	The GlsMovieTexture to reference

Member Function Documentation

CastToGlsMovieTexture()

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

static

Casts a display object to a movie texture.

Parameters

obj	The display object to cast

CurrentAbsoluteFrame() [1/2]

int GlsMovieTexture::CurrentAbsoluteFrame

(

)

Gets the position of the stream pointer by frame number.

Returns

The current stream position frame number

CurrentAbsoluteFrame() [2/2]

None GlsMovieTexture::CurrentAbsoluteFrame

(

int &

frame

)

Sets the position of the stream pointer by frame number.

Parameters

frame

The desired stream position frame number

DurationInMS()

int GlsMovieTexture::DurationInMS

(

)

Gets the length of the movie (in milliseconds).

Returns

The duration of the movie

Loop() [1/2]

bool GlsMovieTexture::Loop

(

)

Gets the looping state of the movie.

Returns

The current looping state

Loop() [2/2]

None 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_loop

The desired looping state

MovieSource() [1/2]

str GlsMovieTexture::MovieSource

(

)

Gets the video source file.

Returns

The name of the source video file

MovieSource() [2/2]

None GlsMovieTexture::MovieSource

(

str

s

)

Sets the desired video source file.

Parameters

s	The source video filename

Paused() [1/2]

bool GlsMovieTexture::Paused

(

)

Gets the paused state of the movie.

Returns

The current pause state

Paused() [2/2]

None GlsMovieTexture::Paused

(

bool &

should_pause

)

Sets the paused state of the movie.

Setting should_pause to True will pause the movie.

Parameters

should_pause

The desired pause state

Playing() [1/2]

bool GlsMovieTexture::Playing

(

)

Gets the playing state of the movie.

Returns

The current play state

Playing() [2/2]

None GlsMovieTexture::Playing

(

bool &

should_play

)

Sets the playing state of the movie.

Setting should_play to False will stop the movie.

Parameters

should_play

The desired play state

PlayPosition() [1/2]

float GlsMovieTexture::PlayPosition

(

)

Gets the position of the stream pointer by percent.

Returns

The current stream position

PlayPosition() [2/2]

None GlsMovieTexture::PlayPosition

(

float &

pct

)

Sets the position of the stream pointer by percent.

Parameters

pct	The desired stream position (0.0 - 1.0)

SoundEnabled() [1/2]

bool GlsMovieTexture::SoundEnabled

(

)

Gets the audio playback behavior.

Returns

True if this movie is playing audio

SoundEnabled() [2/2]

None GlsMovieTexture::SoundEnabled

(

bool &

soundon

)

Sets the audio playback behavior.

Setting soundon to True will enable audio playback.

Parameters

soundon

True if audio should be played

---

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

• GlsMovieTexture.i