Class PAGLayer

constructor

• new PAGLayer(wasmIns): PAGLayer

• Parameters

  • wasmIns: any

  Returns PAGLayer

wasmIns

isDestroyed

uniqueID

• uniqueID(): number

• Returns a globally unique id for this object.

  Returns number

layerType

• layerType(): LayerType

• Returns the type of layer.

  Returns LayerType

layerName

• layerName(): string

• Returns the name of the layer.

  Returns string

matrix

• matrix(): Matrix

• A matrix object containing values that alter the scaling, rotation, and translation of the layer. Altering it does not change the animation matrix, and it will be concatenated to current animation matrix for displaying.

  Returns Matrix

setMatrix

• setMatrix(matrix): void

• Parameters

  • matrix: Matrix

  Returns void

resetMatrix

• resetMatrix(): void

• Resets the matrix to its default value.

  Returns void

getTotalMatrix

• getTotalMatrix(): Matrix

• Returns the layer's display matrix by combining its matrix) property with the current animation matrix from the AE timeline. This does not include the parent layer's matrix. To calculate the final bounds relative to the PAGSurface, use the PAGPlayer::getBounds(PAGLayer layer) method directly.

  Returns Matrix

alpha

• alpha(): number

• Returns the current alpha of the layer if previously set.

  Returns number

setAlpha

• setAlpha(opacity): void

• Set the alpha of the layer, which will be concatenated to the current animation opacity for displaying.

  Parameters

  • opacity: Number

  Returns void

visible

• visible(): boolean

• Whether or not the layer is visible.

  Returns boolean

setVisible

• setVisible(visible): void

• Set the visible of the layer.

  Parameters

  • visible: boolean

  Returns void

editableIndex

• editableIndex(): number

• Ranges from 0 to PAGFile.numTexts - 1 if the layer type is text, or from 0 to PAGFile.numImages -1 if the layer type is image, otherwise returns -1.

  Returns number

parent

• parent(): PAGComposition

• Returns the parent PAGComposition of current PAGLayer.

  Returns PAGComposition

markers

• markers(): Vector<Marker>

• Returns the markers of this layer.

  Returns Vector<Marker>

localTimeToGlobal

• localTimeToGlobal(localTime): number

• Converts the time from the PAGLayer's (local) timeline to the PAGSurface (global) timeline. The time is in microseconds.

  Parameters

  • localTime: number

  Returns number

globalToLocalTime

• globalToLocalTime(globalTime): number

• Converts the time from the PAGSurface (global) to the PAGLayer's (local) timeline timeline. The time is in microseconds.

  Parameters

  • globalTime: number

  Returns number

duration

• duration(): number

• The duration of the layer in microseconds, indicates the length of the visible range.

  Returns number

frameRate

• frameRate(): number

• Returns the frame rate of this layer.

  Returns number

startTime

• startTime(): number

• The start time of the layer in microseconds, indicates the start position of the visible range in parent composition. It could be negative value.

  Returns number

setStartTime

• setStartTime(time): void

• Set the start time of the layer, in microseconds.

  Parameters

  • time: number

  Returns void

currentTime

• currentTime(): number

• The current time of the layer in microseconds, the layer is invisible if currentTime is not in the visible range (startTime <= currentTime < startTime + duration).

  Returns number

setCurrentTime

• setCurrentTime(time): void

• Set the current time of the layer, in microseconds.

  Parameters

  • time: number

  Returns void

getProgress

• getProgress(): number

• Returns the current progress of play position, the value ranges from 0.0 to 1.0.

  Returns number

setProgress

• setProgress(percent): void

• Set the progress of play position, the value ranges from 0.0 to 1.0. A value of 0.0 represents the frame at startTime. A value of 1.0 represents the frame at the end of duration.

  Parameters

  • percent: number

  Returns void

preFrame

• preFrame(): void

• Set the progress of play position to the previous frame.

  Returns void

nextFrame

• nextFrame(): void

• Set the progress of play position to the next frame.

  Returns void

getBounds

• getBounds(): Rect

• Returns a rectangle that defines the original area of the layer, which is not transformed by the matrix.

  Returns Rect

trackMatteLayer

• trackMatteLayer(): PAGLayer

• Returns trackMatte layer of this layer.

  Returns PAGLayer

excludedFromTimeline

• excludedFromTimeline(): boolean

• Indicate whether this layer is excluded from parent's timeline. If set to true, this layer's current time will not change when parent's current time changes.

  Returns boolean

setExcludedFromTimeline

• setExcludedFromTimeline(value): void

• Set the excludedFromTimeline flag of this layer.

  Parameters

  • value: boolean

  Returns void

isPAGFile

• isPAGFile(): boolean

• Returns true if this layer is a PAGFile.

  Returns boolean

asTypeLayer

• asTypeLayer(): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

• Returns this layer as a type layer.

  Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer

isDelete

• isDelete(): boolean

• Returns boolean

destroy

• destroy(): void

• Returns void