ICameraController Interface Members
The following tables list the members exposed by ICameraController.
Public Properties
| Name | Description | |
|---|---|---|
 | AspectRatio | Gets or sets the Aspect Ratio of the viewport, e.g. 1.333f suggests width is 1.333 * height |
| CameraId | Gets or sets the Name or ID of the camera. Does not need to be unique, but can be used by the user to identify a camera |
| FarClip | Gets or sets the Far Clipping distance of the camera. Objects farther than this distance will be invisible to the camera |
| FieldOfView | Gets or sets the Field of View Angle of the Camera in Degrees |
| Forward | Calculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates |
| IsAttached | INTERNAL USE ONLY: Gets or sets whether this camera is attached to the viewport |
| IsSuspended | Gets a value indicating whether updates for the target are currently suspended (Inherited from SciChart.Core.Framework.ISuspendable) |
| NearClip | Gets or sets the Near Clipping distance of the camera. Objects closer than this distance will be invisible to the camera |
| OrbitalPitch | Gets or sets the Pitch angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position |
| OrbitalYaw | Gets or sets the Yaw angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position |
| OrthoHeight | Gets or sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal |
| OrthoWidth | Gets or sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal |
| Position | Gets or sets the Position of the Camera as an XYZ Vector3 in World Coordinates |
| ProjectionMode | Gets or sets the Camera projection mode, e.g. perspective or orthogonal |
| Radius | Calculated Property: Gets or sets the Radius distance of the camera to target in World Units. This property may be manipulated to change the camera position |
| Side | Calculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates |
| Target | Gets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates |
| Up | Calculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates |
| UpGlobal | Calculated Property: Gets the Normalized Global Up Vector equal to Vector3(0,1,0) in LH Coordinate system |
| ZoomToFitOnAttach | When true, the Camera is zoomed to fit the parent SciChart3DSurface scene bounds on attached |
Public Methods
| Name | Description | |
|---|---|---|
 | AttachCameraToViewport | INTERNAL USE: Attaches the camera to the viewport |
| CalculateRadiusToFit | Calculates a Camera target and radius that will fit the bounding box completely inside the viewport. Uses a simple bounding-sphere algorithm |
| DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called (Inherited from SciChart.Core.Framework.ISuspendable) |
| LocalCoordinateToScreenSpace | Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices |
| ResetToDefaults | Resets the camera to default position, target and orientation |
| ResumeUpdates | Resumes updates on the target, intended to be called by IUpdateSuspender (Inherited from ) |
| SuspendUpdates | Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued (Inherited from ) |
| ToOrthogonal | Switches the camera to Orthogonal mode |
| ToPerspective | Switches the camera to Perspective mode |
| WorldToScreenSpace | Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices |
Public Events
| Name | Description | |
|---|---|---|
 | CameraUpdated | Event raised whenever the Camera properties are updated and the parent requires a redraw |
See Also