ProtectedconstructorReturns true if the camera has not moved or changed for some time interval.
Deterimes if user input is processed.
ReadonlysettingsThe settings for the scene camera.
Counter that increments every frame when the camera transform changes.
Static ReadonlydollyStatic ReadonlydollyStatic ReadonlyorientationStatic ReadonlypositionStatic ReadonlysleepStatic ReadonlyuntilActivates or deactivates the component.
The returned active state also accounts for the active state of the parent SceneObject.
Various flags set on the component that affect it's behavior.
Determines whether the component itself is active, without accounting for the active state of the parent scene object.
Determines if the camera is currently animating.
Determines if the object has been destroyed.
Determines if the rendering of this camera has been paused.
Determines if the component is currently active, enabled and running.
True, if the camera is currently tracking any user.
Retrieves the camera mode.
Determines the cases that will trigger the onTransformChanged event.
Returns the PhysicsScene this node is being simulated on.
The signed execution priority of the component.
Determines order of execution of this component in relation to other components, higher priorities will execute earlier.
The priority value determines the order of initialize, enable and update calls.
Valid priorities are in the range [-100...100], other priorities are reserved for internal use.
The priority should not be modified after onCreate has been called.
The default priority for user implement components is -10. BuiltinComponent have a default priority of 0. However, instances that have dependencies or are a dependency to another component might have non zero default priorities. For example, the Camera component has a default priority of 50 as other components may depend on the camera being initialized early. The Rigidbody component has a default priority of 22 and Joint components have a priority of 20 as the joint depends on fully initialized rigid bodies.
Determines how often the camera renders. Normally you always want to keep the render mode to CameraRenderMode.OnDemand unless you know the viewport will require updates every frame (e.g. when a game is running, or when previewing animations).
Returns the SceneInstance this node is attached to.
Returns the SceneObject this component is attached to.
Gets the current user settings.
Returns a universally unique identifier that persists scene save/load.
Virtual
Applies the settings to the camera.
OptionalpreserveAspect: booleanCalculates distance at which the camera's frustum width is equal to the provided width.
Frustum width to find the distance for, in world units.
Distance at which the camera's frustum is the specified width, in world units.
Destroys the component, removing it from its scene object and stopping component updates.
Optionalimmediate: boolean
If true the component will be fully destroyed immediately. This means that objects that are still referencing this component might fail. Normally destruction is delayed until the end of the frame to give other objects a chance to stop using it.
Moves and orients a camera so that the provided bounds end up covering the camera's viewport.
Bounds to frame in camera's view.
Optionalposition: Immutable<Vector3>
position to be used as pivot, defaults to center of bounds.
OptionalcalculateCameraDistance: boolean
False when the distance of the camera from position should be kept unchanged.
Optionalpadding: number
Amount of padding to leave on the borders of the viewport, in percent [0...1].
Optionaltime: number
The camera animation time.
OptionalisKeepingFrustumWidth: boolean
Whether to keep the currently set frustum width. If true, the near and far planes will not change.
Focuses the camera on the currently focus point.
Focuses the camera on the specified objects.
OptionalanimationTime: numberOptionalcalculateCameraDistance: booleanChecks if the component has a specific ComponentFlag bit flag set.
The flag to check.
Virtual
Initializes the ShortcutAction and button mappings for the specified context.
The shortcut context.
Virtual
Initializes this instances for the specified viewport window
Calls a parameterless method with the specified name, on the component.
Name of the method to call.
true if the method was invoked.
Moves the camera to the given position and rotation in the given amount of time.
The target position.
The target rotation.
The length of the camera animation.
Notifies the system of a new mouse event to be consumed.
The mouse event.
Notifies the system of a new mouse wheel event to be consumed.
The mouse event.
Virtual
Notifies the system that the 3D viewport should be redrawn.
Virtual
Notifies the system that the settings changed and must be commited.
ProtectedonProtectedonProtectedonVirtual
Called every time a component is placed into the Stopped state.
This method may be called during component destruction, if the component wasn't already in ScenePlayState.Stopped state during destruction. When called during destruction, it is called before onDestroy.
ProtectedonVirtual
Called every time a component leaves the ScenePlayState.Stopped state.
This method might be called during component creation, if the requirements for leaving the stopped state are met. One such case would be a component class that has the runInEditor attribute. When called during creation it is called after onInitialize.
Called at fixed time intervals (e.g. 60 times per frame). Only called if the component is in ScenePlayState.Playing state.
ProtectedonVirtual
Called once when the component first leaves the ScenePlayState.Stopped state.
This method might be called during component creation, if the requirements for leaving the stopped state are met. One such case would be a component class that has the runInEditor attribute. When called during creation it is called after onCreate.
Virtual
Called once per frame, after all other components received their onUpdate invocation. Only called if the component is in ScenePlayState.Playing state.
This method should only be implemented if your component needs logic that implements on other component or SceneObject changes performend in onUpdate. An example could be a camera controller logic that updates in response to changes to the object that is being tracked.
ProtectedonVirtual
Called when the script domain has been refreshed or when the component is initialized. During initialization it is called after onInitialize but before onEnable.
ProtectedonVirtual
Called when the component's parent SceneObject has changed.
The transform flags.
This method is only called if TransformChangedFlag.Transform is set on the Component#notifyFlags. The method will also not be called if the component is currently in the ScenePlayState.Stopped state.
To get the event for editor components that are active outside the simulation, attach the runInEditor attribute to your component class.
Virtual
Called once per frame. Only called if the component is in ScenePlayState.Playing state.
Virtual
Invoked when the viewport shuts down.
Sets or unsets the specified ComponentFlag bit flag on the instance.
The flag to set.
True to set the flag.
Changes the scene camera projection type and animates the transition.
New projection type.
Registers the coroutine for the specified component using the provided args as arguments.
true if the coroutine was registered.
The coroutine will be called for the first time when the coroutine subsystem runs for update events.
There is no guarantee with regards to the order of how coroutines are invoked.
Coroutines are a great way for time-deferred or delayed system. To implement a coroutine simply add a
generator method to your component and register it as coroutine:
public *myCoroutine(text:string)
{
const endTime:number = Time.realElapsed + 3;
while(Time.realElapsed < endTime)
{
yield true;
}
Debug.log("This code will be invoked after 3 seconds with the text=" + text);
}
To register the function simply call
this.startCoroutine(this.myCoroutine, "Hello World!");
The function will be invoked once the coroutine runs. The coroutine function can yield the program
control flow by using the keyword yield. The coroutine will then stop execution at that point,
and pick up the execution in the next update event, right after the yield keyword that caused
the coroutine to pause.
With helper functions such as waitForSeconds or waitForAsyncOp it is easy to create coroutines that pause for a set time interval.
Registers the coroutine for the specified component using the provided args as arguments.
true if the coroutine was registered.
The coroutine will be called for the first time when the coroutine subsystem runs for fixedUpdate events.
There is no guarantee with regards to the order of how coroutines are invoked.
Coroutines are a great way for time-deferred or delayed system. To implement a coroutine simply add a
generator method to your component and register it as coroutine:
public *myCoroutine(text:string)
{
const endTime:number = Time.realElapsed + 3;
while(Time.realElapsed < endTime)
{
yield true;
}
Debug.log("This code will be invoked after 3 seconds!");
}
To register the function simply call
this.startCoroutine(this.myCoroutine, "Hello World!");
The function will be invoked once the coroutine runs. The coroutine function can yield the program
control flow by using the keyword yield. The coroutine will then stop execution at that point,
and pick up the execution in the next fixedUpdate event, right after the yield keyword that caused
the coroutine to pause.
With helper functions such as waitForSeconds or waitForAsyncOp it is easy to create coroutines that pause for a set time interval.
Stops the coroutine for the specified component.
The coroutine to stop.
true if the coroutine was registered.
Returns a string representation of an object.
StaticcalculateCalculates the camera near and far plane distances used for looking at an object certain distance from the camera.
Distance of the object from the camera.
Anonymous object.
Far plane distance
Near plane distance.
StaticgetLocates a rsx object by its sceneRuntimeID and UUID.
The runtime ID of the SceneInstance of the object.
The UUID of the object to retrieve.
The object or null if no object with given sceneRuntimeID and uuid has been registered
StaticisDetermines if any of the shortcut actions is currently held.
The actions.
True if a shortcut is held.
The ViewportCamera implements a Component for camera movement and behaviors such as orbiting for camera viewports that are rendered using the UIViewportRenderer.
Example