new AxOrbitInputModel(context, pivotalTransform, orbitalTransform, rotationSpeed, rotationResponsiveness, upInput, downInput, leftInput, rightInput, rollLeftInput, rollRightInput, orbitConditionInput)
Creates an input model, which provides orbiting of the camera around a given transform
Useful for examinig and object by rotating the camera around it an seeing it from different angles
For multiple alternative inputs on the same control, enumerate all the input names, separated by comma.
Both digital and analog inputs are acceptable, such as keyboard, mouse, gamepad buttons as well as mouse coordinates and gamepad thumbsticks and triggers
For analog inputs, which provide positive and negative values, only one of two opposing controls is required. For example, when using the mouse to turn left and right, only the left or only the right control is sufficient in this case, because a negative value from the input would reverse the turning direction.
The model provides inputs to serve as manipulation conditions. If these inputs are provided, manipulating will only occur if the given conditional input is active. For example, to turn by moving the mouse, but only while mouse button is pressed, the mouse button must be provided as conditional input.
Parameters:
| Name | Type | Description |
|---|---|---|
context |
Axis | The instance of Axis, to which the model will be applied |
pivotalTransform |
AxTransform | The transform which is to act as a pivot for orbiting around |
orbitalTransform |
AxTransform | The transform which is to orbit around the pivotal transform. If null, the transform of the current camera in the scene is assumed |
rotationSpeed |
Number | The rotation speed multiplier in turns per second per input at which to turn |
rotationResponsiveness |
Number | The rotation responsiveness, where 0 is no responsiveness at all and greater values result in a more responsive rotation. Smaller values result in a more inert rotation. Must be greater than 0 in order for any rotation to occur |
upInput |
String | AxString | Names of the inputs to control the up rotation. Passing a null or empty string value would discard the control. |
downInput |
String | AxString | Names of the inputs to control the down rotation. Passing a null or empty string value would discard the control. |
leftInput |
String | AxString | Names of the inputs to control the left rotation. Passing a null or empty string value would discard the control. |
rightInput |
String | AxString | Names of the inputs to control the right rotation. Passing a null or empty string value would discard the control. |
rollLeftInput |
String | AxString | Names of the inputs to control the roll left rotation. Passing a null or empty string value would discard the control. |
rollRightInput |
String | AxString | Names of the inputs to control the roll right rotation. Passing a null or empty string value would discard the control. |
orbitConditionInput |
String | AxString | Names of the inputs to serve as a condition for allowing orbiting. Passing a null or empty string value would discard the condition. |
Methods
Process()
Performs the input model routines