Layer | AE Expressions

Class Layer

Hierarchy

Layer

Index

Constructors

constructor

Properties

Constructors

constructor

new Layer(): Layer

Returns Layer

Properties

Readonly active

active: boolean = true

Whether the video switch is enabled, and the current time is between in the inPoint and outPoint of the layer

Optional Readonly audioActive

audioActive: boolean = true

Whether the audio switch is enabled, and the current time is in between the inPoint and outPoint of the layer

Optional Readonly audioLevels

audioLevels: Property<Vector2D> = ...

The value of the Audio Levels property of the layer, in decibels. This value is a 2D value; the first value represents the left audio channel, and the second value represents the right. The value is not the amplitude of the audio track of the source material. Instead, it is the value of the Audio Levels property, which may be affected by keyframes.

Readonly colorDepth

colorDepth: number = 8

The project color depth value. For example, colorDepth returns 16 when the project color depth is 16 bits per channel.

Readonly enabled

enabled: boolean = true

Whether the video switch for the layer is enabled

Readonly hasAudio

hasAudio: boolean = true

Whether the layer has audio data

Readonly hasParent

hasParent: boolean = true

Whether the layer has a parent layer

Readonly hasVideo

hasVideo: boolean = true

Whether the layer has video data

Readonly height

height: number = 1080

The height of the layer in pixels, same as source.height

Readonly inPoint

inPoint: number = 0

The in point of the layer, in seconds

Readonly index

index: number = 0

The index number of the layer in the composition

Optional Readonly marker

marker: MarkerProperty = ...

The marker property group object

Optional Readonly materialOption

materialOption: MaterialOptions = ...

The material options property group object

Readonly name

name: string = "Layer name"

The name of the layer

Readonly outPoint

outPoint: number = 1

The out point of the layer in seconds

Optional Readonly parent

parent: Camera | Layer | Light = ...

The parent Layer object of the layer, if it has one

Optional Readonly source

source: Comp | Footage = ...

The source Comp or source Footage object for the layer. Default time is adjusted to the time in the source

Readonly startTime

startTime: number = 0

The start time of the layer in seconds

Optional Readonly text

text: Text = ...

The text property group object

Readonly time

time: number = 0

The composition time, in seconds, at which the expression is being evaluated.

Optional Readonly timeRemap

timeRemap: Property<number> = ...

The value of the Time Remap property, in seconds, if Time Remap is enabled.

Readonly transform

transform: Transform = ...

The transform property group object

Readonly width

width: number = 1920

The width of the layer in pixels, same as source.width

Methods

add

add<A, B>(a: A, b: B): MathReturn<A, B>

- Defined in index.ts:1467
Adds two vectors

Type parameters
- A: NumericValue
- B: NumericValue
Parameters
- a: A
- b: B
Returns MathReturn<A, B>

clamp

clamp<T>(value: T, limit1: number, limit2: number): T

- Defined in index.ts:1510
Constrains a given number, or each element of an array, to fall within a a given range

Type parameters
- T: NumericValue
Parameters
- value: T
  
  Array or number to constrain
- limit1: number
  
  Lower limit
- limit2: number
  
  Upper limit
Returns T

comp

comp(name: string): Comp

- Defined in index.ts:1377
Retrieves a composition by name

Parameters
- name: string
  
  The name of the composition
Returns Comp

The composition with the given name

cross

cross(vec1: Vector, vec2: Vector): Vector

- Defined in index.ts:1526
Parameters
- vec1: Vector
- vec2: Vector
Returns Vector

the cross product of two vectors

degreesToRadians

degreesToRadians(degrees: number): number

- Defined in index.ts:1353
Convert a given value in degrees to radians

Parameters
- degrees: number
  
  The value to convert
Returns number

The value radians

div

div<VectorType>(vec1: VectorType, amount: number): VectorType

- Defined in index.ts:1498
Divides a vector by a given scalar amount

Type parameters
- VectorType: NumericValue
Parameters
- vec1: VectorType
  
  The vector to divide
- amount: number
  
  The amount to divide by
Returns VectorType

dot

dot(vec1: Vector, vec2: Vector): Vector

- Defined in index.ts:1520
Parameters
- vec1: Vector
- vec2: Vector
Returns Vector

the dot (inner) product of two vectors

ease

ease(t: number, tMin: number, tMax: number, value1?: number | [], value2?: number | []): number | []

- Defined in index.ts:1611
Parameters
- t: number
  
  The input value to be re-mapped
- tMin: number
  
  The inputs low floor
- tMax: number
  
  The inputs high ceiling
- Optional value1: number | []
  
  The output floor
- Optional value2: number | []
  
  The output ceiling
Returns number | []

A given value, mapped from one range to another, clamped to the output range. The mapping will ease in and out so it reaches the output range with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.

easeIn

easeIn(t: number, tMin: number, tMax: number, value1?: number | [], value2?: number | []): number | []

- Defined in index.ts:1628
Parameters
- t: number
  
  The input value to be re-mapped
- tMin: number
  
  The inputs low floor
- tMax: number
  
  The inputs high ceiling
- Optional value1: number | []
  
  The output floor
- Optional value2: number | []
  
  The output ceiling
Returns number | []

A given value, mapped from one range to another, clamped to the output range. The mapping will ease out with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.

easeOut

easeOut(t: number, tMin: number, tMax: number, value1?: number | [], value2?: number | []): number | []

- Defined in index.ts:1645
Parameters
- t: number
  
  The input value to be re-mapped
- tMin: number
  
  The inputs low floor
- tMax: number
  
  The inputs high ceiling
- Optional value1: number | []
  
  The output floor
- Optional value2: number | []
  
  The output ceiling
Returns number | []

A given value, mapped from one range to another, clamped to the output range. The mapping will ease into the output range with a velocity of 0. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.

effect

effect(nameOrIndex: string | number): Effect

- Defined in index.ts:1321
Get the effect on a layer with a given name or index.

Parameters
- nameOrIndex: string | number
  
  The effect's name or index
Returns Effect

The first effect with the given name, or at the given index

footage

footage(name: string): Footage

- Defined in index.ts:1369
Gets the footage object for the item with the provided name

Parameters
- name: string
  
  The file name of the footage item
Returns Footage

The relevant footage item

framesToTime

framesToTime(frames: number, fps?: number): number

- Defined in index.ts:1400
Converts a number of frames to time in seconds

Parameters
- frames: number
  
  The frame count to convert
- fps: number = ...
  
  The frames per second use in the calculation
Returns number

The given frames as time

fromComp

fromComp<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1240
Transforms a given vector from the compositions space to the layer's space

Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
  
  The vector to transform
- time: number = ...
  
  The time to sample the vector
Returns VectorType

The vector in the layer's space

fromCompToSurface

fromCompToSurface<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1290
Projects a point located in composition space to a point on the surface of the layer (zero z-value) at the location where it appears when viewed from the active camera.

Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
  
  The vector to transform
- time: number = ...
  
  The time to sample the number
Returns VectorType

The vector in on the layers surface space

fromCompVec

fromCompVec<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1265
Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
- time: number = ...
Returns VectorType

fromWorldVec

fromWorldVec<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1277
Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
- time: number = ...
Returns VectorType

gaussRandom

gaussRandom(minValOrArray?: number | [], maxValOrArray?: number | []): number | []

- Defined in index.ts:1572
Parameters
- Optional minValOrArray: number | []
  
  If only one argument is provided, the max value for the random number, otherwise the minimum value
- Optional maxValOrArray: number | []
  
  The maximum value to return
Returns number | []

a random value with a gaussian distribution either between 0 and 1, 0 and the first argument, or the first and second argument if two are provided. If the arguments are arrays, an equal length array of random values will be returned

hexToRgb

hexToRgb(hex: string): Color

- Defined in index.ts:1674
Converts a color in hex triplet space to RGB, or in hex quartet space to RGBA space. For hex triplets, alpha defaults to 1.0

Parameters
- hex: string
  
  String representing an hex triplet (6 digits, no alpha channel) or quartet (8 digits, includes alpha channel) containing only numerals or characters A–F. Optional leading characters 0x, 0X, or # are ignored. Characters beyond 8 digits are ignored.
Returns Color

hslToRgb

hslToRgb(hslaArray: Color): Color

- Defined in index.ts:1667
Converts a color in HSLA space to RGBA

Parameters
- hslaArray: Color
Returns Color

An array of red, green, blue and alpha values between 0 and 1

length

length(point1: Vector, point2?: Vector): number

- Defined in index.ts:1538
Parameters
- point1: Vector
- Optional point2: Vector
Returns number

The length of a given vector, or if two vectors are provided the distance between them

linear

linear(t: number, tMin: number, tMax: number, value1?: number | [], value2?: number | []): number | []

- Defined in index.ts:1594
Parameters
- t: number
  
  The input value to be re-mapped
- tMin: number
  
  The inputs low floor
- tMax: number
  
  The inputs high ceiling
- Optional value1: number | []
  
  The output floor
- Optional value2: number | []
  
  The output ceiling
Returns number | []

A given value, mapped from one range to another, clamped to the output range. If only 3 parameters are given, the input range is 0 to 1 and the given values are used for the output range.

lookAt

lookAt(fromPoint: Vector, atPoint: Vector): Vector3D

- Defined in index.ts:1547
Used to orient a layer towards a given point in 3D space

Parameters
- fromPoint: Vector
  
  The location in world space of the layer you want to orient
- atPoint: Vector
  
  The point in world space you want to point the layer at
Returns Vector3D

An orientation value that can be used to orient the layer so that the z-axis points at the atPoint

mask

mask(nameOrIndex: string | number): Mask

- Defined in index.ts:1329
Get the mask on a layer with a given name or index.

Parameters
- nameOrIndex: string | number
  
  The mask's name or index
Returns Mask

The first mask with the given name, or at the given index

mul

mul<VectorType>(vec1: VectorType, amount: number): VectorType

- Defined in index.ts:1487
Multiplies a vector by a given scalar amount

Type parameters
- VectorType: NumericValue
Parameters
- vec1: VectorType
  
  The vector to multiply
- amount: number
  
  The amount to multiply by
Returns VectorType

noise

noise(valOrArray: number | []): number

- Defined in index.ts:1583
Used to get a random value via Perlin noise, where inputs values that are close together will result in output values that are closer together.

Parameters
- valOrArray: number | []
  
  The noise input value
Returns number

A value between -1 and 1

normalize

normalize(vec1: Vector): Vector

- Defined in index.ts:1532
Parameters
- vec1: Vector
Returns Vector

The given vector normalized so it has a length of 1

radiansToDegrees

radiansToDegrees(radians: number): number

- Defined in index.ts:1361
Convert a given value in radians to degrees

Parameters
- radians: number
  
  The value to convert
Returns number

The value radians

random

random(minValOrArray?: number | [], maxValOrArray?: number | []): number | []

- Defined in index.ts:1561
Parameters
- Optional minValOrArray: number | []
  
  If only one argument is provided, the max value for the random number, otherwise the minimum value
- Optional maxValOrArray: number | []
  
  The maximum value to return
Returns number | []

a random value either between 0 and 1, 0 and the first argument, or the first and second argument if two are provided. If the arguments are arrays, an equal length array of random values will be returned

rgbToHsl

rgbToHsl(rgbaArray: Color): Color

- Defined in index.ts:1659
Converts a color in RGBA space to HSLA

Parameters
- rgbaArray: Color
  
  Input RGBA array of values between 0 and 1
Returns Color

An array of hue, saturation, lightness and alpha values between 0 and 1

sampleImage

sampleImage(point: Vector2D, radius?: Vector2D, postEffect?: boolean, time?: number): Color

- Defined in index.ts:1340
Sample a layers color at a given point

Parameters
- point: Vector2D
  
  The center point of the sampling area, in layer space
- radius: Vector2D = ...
  
  Defines the sample area size, the horizontal and vertical distance from the center
- postEffect: boolean = true
  
  Whether to sample the layer after effects and masks are applied
- time: number = ...
  
  The time at which to sample
Returns Color

The average color of the layer in the sample area

seedRandom

seedRandom(offset: number, timeless?: boolean): void

- Defined in index.ts:1555
Used to modify the random seed for an expression

Parameters
- offset: number
  
  A value used to modify the random seed
- timeless: boolean = false
  
  Whether the random seed should be consistent across time
Returns void

sourceRectAtTime

sourceRectAtTime(time?: number, includeExtents?: boolean): SourceRect

- Defined in index.ts:1310
Gets the layer's size and position at a given time

Parameters
- time: number = ...
  
  The time at which to get the layers bounds
- includeExtents: boolean = false
  
  Whether to include areas of the layer outside the bounding box. Applies to Shape Layers and Paragraph Text.
Returns SourceRect

An object with properties for layers top, left, width and height values at the given time.

Optional sourceTime

sourceTime(time?: number): Footage

- Defined in index.ts:1301
Returns the layer's source item at the given time

Parameters
- time: number = ...
  
  The time at which to get the source
Returns Footage

The source item

sub

sub<A, B>(a: A, b: B): MathReturn<A, B>

- Defined in index.ts:1476
Subtracts two vectors

Type parameters
- A: NumericValue
- B: NumericValue
Parameters
- a: A
- b: B
Returns MathReturn<A, B>

timeToCurrentFormat

timeToCurrentFormat(t?: number, fps?: number, isDuration?: boolean, ntscDropFrame?: boolean): string

- Defined in index.ts:1455
Converts a given time in seconds to the current time display format of the Project.

Parameters
- t: number = ...
  
  The time to convert
- fps: number = ...
  
  Frame rate to use for the conversion
- isDuration: boolean = false
  
  Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
- ntscDropFrame: boolean = ...
Returns string

timeToFeetAndFrames

timeToFeetAndFrames(t?: number, fps?: number, framesPerFoot?: number, isDuration?: boolean): string

- Defined in index.ts:1440
Converts a given time in seconds to a string representing feet of film and frames.

Parameters
- t: number = ...
  
  The time to convert
- fps: number = ...
  
  Frame rate to use for the conversion
- framesPerFoot: number = 16
  
  Number of frames in one foot of film
- isDuration: boolean = false
  
  Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Returns string

timeToFrames

timeToFrames(t?: number, fps?: number, isDuration?: boolean): number

- Defined in index.ts:1387
Converts a given time in seconds to an integer amount of frames

Parameters
- t: number = ...
  
  The time to convert in seconds
- fps: number = ...
  
  Frames per second to calculate with, defaulting to the compositions frame rate
- isDuration: boolean = false
  
  Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Returns number

The time in frames

timeToNTSCTimecode

timeToNTSCTimecode(t?: number, ntscDropFrame?: boolean, isDuration?: boolean): string

- Defined in index.ts:1426
Converts a given time value to a NTSC timecode string

Parameters
- t: number = ...
  
  The time to convert
- ntscDropFrame: boolean = false
- isDuration: boolean = false
  
  Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Returns string

timeToTimecode

timeToTimecode(t?: number, timecodeBase?: number, isDuration?: boolean): string

- Defined in index.ts:1413
Converts the given time value to a timecode string (e.g. "00:00:00:00")

Parameters
- t: number = ...
  
  The time to convert
- timecodeBase: number = 30
  
  The frames per second to use in the calculation
- isDuration: boolean = false
  
  Whether t represents a duration rather than an absolute time. Durations are rounded away from zero rather than down.
Returns string

The time as a timecode string

toComp

toComp<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1227
Transforms a given vector from the layer's space to the composition space

Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
  
  The vector to transform
- time: number = ...
  
  The time to sample the vector
Returns VectorType

The vector in the composition space

toCompVec

toCompVec<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1259
Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
- time: number = ...
Returns VectorType

toWorld

toWorld<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1253
Transforms a given vector from the layers space to the view-independent world space

Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
  
  The vector to transform
- time: number = ...
  
  The time to sample the number
Returns VectorType

The vector in world space

toWorldVec

toWorldVec<VectorType>(vec: VectorType, time?: number): VectorType

- Defined in index.ts:1271
Type parameters
- VectorType: Vector
Parameters
- vec: VectorType
- time: number = ...
Returns VectorType

Generated using TypeDoc

Sunbelt Computer Software

PL/B Language Development and Support

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Layer

Properties

Readonly active

Optional Readonly audioActive

Optional Readonly audioLevels

Readonly colorDepth

Readonly enabled

Readonly hasAudio

Readonly hasParent

Readonly hasVideo

Readonly height

Readonly inPoint

Readonly index

Optional Readonly marker

Optional Readonly materialOption

Readonly name

Readonly outPoint

Optional Readonly parent

Optional Readonly source

Readonly startTime

Optional Readonly text

Readonly time

Optional Readonly timeRemap

Readonly transform

Readonly width

Methods

add

Type parameters

A: NumericValue

B: NumericValue

Parameters

a: A

b: B

Returns MathReturn<A, B>

clamp

Type parameters

T: NumericValue

Parameters

value: T

limit1: number

limit2: number

Returns T

comp

Parameters

name: string

Returns Comp

cross

Parameters

vec1: Vector

vec2: Vector

Returns Vector

degreesToRadians

Parameters

degrees: number

Returns number

div

Type parameters

VectorType: NumericValue

Parameters

vec1: VectorType

amount: number

Returns VectorType

dot

Parameters

vec1: Vector

vec2: Vector

Returns Vector

ease

Parameters

t: number

tMin: number