Content Target#

Note

Only supported on Atlas and Atlas Pro.

A ContentTarget object is returned from get_content_target.

Properties#

Property

Value Type

Description

master_intensity_level

Variant

rotation_offset

float

Atlas Pro only

x_position_offset

float

Atlas Pro only

y_position_offset

float

Atlas Pro only

For example, on a Atlas:

target = get_content_target(1)
current_level = target.master_intensity_level

And on a Atlas Pro:

target = get_content_target(1, PRIMARY)
current_angle = target.rotation_offset

Member functions#

The following are member functions of ContentTarget objects.

set_master_intensity#

set_master_intensity(level[, fade[, delay]])

Masters the intensity of the content target according to the parameters:

Parameter

Value Type

Description

Value Example

level

float (0.0-1.0) or integer (0-255)

Master level to set on the content target.

0.5 or 128

fade

float

Optional. Fade time to apply the intensity change, in seconds.

2.0

delay

float

Optional. Time to wait before applying the intensity change, in seconds.

3.0

For example, on a Atlas:

-- Master the primary content target in composition 1 to 50% (128/255 = 0.5) in 3 seconds
get_content_target(1):set_master_intensity(128,3)

Or on a Atlas Pro:

-- Master the secondary content target in composition 2 to 100% in 2.5 seconds
get_content_target(2, SECONDARY):set_master_intensity(255,2.5)

transition_rotation#

Note

Only supported on Atlas Pro.

transition_rotation([angle[, count[, period[, delay[, useShortestPath]]]]])

Applies a rotation to the content target according to the parameters:

Parameter

Value Type

Description

Value Example

angle

float

Optional. Angle of rotation to transition to, in degrees. Defaults to zero.

90.0

count

integer

Number of times to repeat the rotation transformation.

1

period

integer

The period of the rotation, in seconds - the time to perform one count of the transformation.

2

delay

integer

Time to wait before starting the rotation, in seconds.

0

transition_y_position#

transition_y_position([y_offset[, count[, period[, delay]]]])

Moves the content target along the y axis according to the parameters:

Parameter

Value Type

Description

Value Example

y_offset

float

Optional. Offset to apply to the y position. Defaults to 0.

25.0

count

integer

Number of times to repeat the y translation.

1

period

integer

The period of the translation, in seconds - the time to perform one count of the transformation.

2

delay

integer

Time to wait before starting the translation, in seconds.

0