Adjustment Target#

Note

Only supported on Atlas Pro.

An Adjustment object is returned from get_adjustment.

Properties#

Property

Value Type

rotation_offset

float

x_position_offset

float

y_position_offset

float

For example:

target = get_adjustment(1)
r_offset = target.rotation_offset

Member functions#

The following are member functions of Adjustment objects.

transition_rotation#

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

Applies a rotation to the adjustment 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_x_position#

transition_x_position([x_offset[, count[, period[, delay]]]])

Moves the adjustment target along the x axis according to the parameters:

Parameter

Value Type

Description

Value Example

x_offset

float

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

25.0

count

integer

Number of times to repeat the x 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

transition_y_position#

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

Moves the adjustment 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