OIL2 Class Standard.DrawingMovie

class Standard . DrawingMovie {
        array   canvasSize;
        array   frameList;
        int32   frameRate;
        int32   frameTotal;
} inherits from Object;

DESCRIPTION

A DrawingMovie maintains a collection of DrawingFrame objects.

METHODS

Standard.DrawingMovie:create

DrawingMovie:create(optional int32 min_x, optional int32 min_y)

Method Description

The default canvas is 0,0 - 1000,1000. The default frame rate is 12.

Standard.DrawingMovie:initialize

DrawingMovie:initialize(int32 min_x, int32 min_y, int32 max_x, int32 max_y, int32 rate)

Method Description

Standard.DrawingMovie:addFrame

DrawingMovie:addFrame(oid frameObj)

Method Description

Adds a a new DrawingFrame object to the collection.

Return Value

Returns the id of the frame.

Standard.DrawingMovie:deleteFrame

DrawingMovie:deleteFrame(int32 frameId)

Method Description

Deletes an existing DrawingFrame.

Return Value

Returns zero.

Standard.DrawingMovie:setSize

DrawingMovie:setSize()

Method Description

Alters the canvas size.

Return Value

Returns zero.

Standard.DrawingMovie:getSize

DrawingMovie:getSize()

Method Description

Returns a two-element array representing the width and height of the drawing canvas.

Return Value

Returns zero.

Standard.DrawingMovie:setFrameRate

DrawingMovie:setFrameRate(int32 fps)

Method Description

Sets the desired rate for rendering of DrawingFrame objects. o

Return Value

Returns zero.

Standard.DrawingMovie:getFrameRate

DrawingMovie:getFrameRate()

Method Description

Returns the desired frame rate.

Standard.DrawingMovie:getFrameTotal

DrawingMovie:getFrameTotal()

Method Description

Returns the total number of DrawingFrame objects associated with the DrawingMovie.

Standard.DrawingMovie:getFrameObject

DrawingMovie:getFrameObject(int32 frameId)

Method Description

Returns the object Id of the DrawingFame object corresponding to the frame specified by frameId.