---
title: "AnimationAxisSettings"
description: "API documentation for AnimationAxisSettings"
url: https://developer.disguise.one/python-api/docs/animationaxissettings/
---

# AnimationAxisSettings

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

Subclasses: _[SpatialCalibrationFrameOfReference](/python-api/docs/spatialcalibrationframeofreference#spatialcalibrationframeofreference)_, _[TrackingFrameOfReference](/python-api/docs/trackingframeofreference#trackingframeofreference)_

## Properties

#### **customScale** : _float_

User defined scale applied in external system coordinates to the object, before any translation

_UserName: Custom scale_

#### **directionX** : _int_

The direction of travel of the object when X values increase in the external system

_Options: {0: ‘Stage Left’, 1: ‘Stage Right’, 2: ‘Up’, 3: ‘Down’, 4: ‘Upstage’, 5: ‘Downstage’}  
UserName: +ve X_

#### **directionY** : _int_

The direction of travel of the object when Y values increase in the external system

_Options: {0: ‘Stage Left’, 1: ‘Stage Right’, 2: ‘Up’, 3: ‘Down’, 4: ‘Upstage’, 5: ‘Downstage’}  
UserName: +ve Y_

#### **directionZ** : _int_

The direction of travel of the object when Z values increase in the external system

_Options: {0: ‘Stage Left’, 1: ‘Stage Right’, 2: ‘Up’, 3: ‘Down’, 4: ‘Upstage’, 5: ‘Downstage’}  
UserName: +ve Z_

#### **invertXRotation** : _bool_

_UserName: Invert X rotation_

#### **invertYRotation** : _bool_

_UserName: Invert Y rotation_

#### **invertZRotation** : _bool_

_UserName: Invert Z rotation_

#### **localOffset** : _[Vec](/python-api/docs/vec#vec)_

Offset applied in external system coordinates to the object, before any rotation

_UserName: Local offset_

#### **localPos** : _[Vec](/python-api/docs/vec#vec)_

Rotation pivot point, in external system coordinates

_UserName: Local rotation pivot_

#### **localRot** : _[Vec](/python-api/docs/vec#vec)_

Rotation applied in external system coordinates entirely before the tracked rotation

_UserName: Local rotation_

#### **stagePos** : _[Vec](/python-api/docs/vec#vec)_

Object position when the external system is at position 0

_UserName: Stage offset_

#### **stageRot** : _[Vec](/python-api/docs/vec#vec)_

Object rotation when the external system is at rotation 0. Note that the directions specified above cross over with this setting

_UserName: Stage rotation_

#### **units** : _int_

Linear distance measurement units supplied by the external system

_Options: {0: ‘Meters’, 1: ‘Centimeters’, 2: ‘Millimeters’, 3: ‘Feet’, 4: ‘Inches’, 5: ‘Custom’}  
UserName: Units_

## Constructors

#### **\_\_init\_\_**(self)