public interface ICameraController extends com.scichart.core.framework.IAttachable, com.scichart.core.IServiceProvider, com.scichart.core.framework.ISuspendable, IUpdatable3D, com.scichart.core.framework.IInvalidatableElement
SciChartSurface3D
sceneModifier and Type | Method and Description |
---|---|
void |
animate(Vector3 position,
Vector3 target,
long duration)
Animates camera to specified
position and target position with specified duration |
void |
animateZoomToFit(long duration)
Zooms camera to fit bounding box of parent surface inside the viewport using current camera position as reset position
|
void |
animateZoomToFit(Vector3 resetPosition,
long duration)
Zooms camera to fit bounding box of parent surface inside the viewport using current camera position as reset position
|
float |
calculateRadiusAndTargetToFit(Vector3 targetToFit)
Calculates a Camera target and radius that will fit the bounding box completely inside the viewport.
|
float |
getAspectRatio()
Gets the Aspect Ratio of the viewport, e.g.
|
float |
getFarClip()
Gets the Far Clipping distance of the camera.
|
float |
getFieldOfView()
Gets the Field of View Angle of the Camera in Degrees
|
Vector3 |
getForward()
Calculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates
|
float |
getNearClip()
Gets the Near Clipping distance of the camera.
|
float |
getOrbitalPitch()
Gets the Pitch angle of the camera position relative to the target in DEGREES.
|
float |
getOrbitalYaw()
Gets the Yaw angle of the camera position relative to the target in DEGREES.
|
float |
getOrthoHeight()
Gets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal
|
float |
getOrthoWidth()
Gets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal
|
Vector3 |
getPosition()
Gets the Position of the Camera as an XYZ Vector3 in World Coordinates
|
CameraProjectionMode |
getProjectionMode()
Gets the Camera projection mode, e.g.
|
float |
getRadius()
Calculated Property: Gets the Radius distance of the camera to target in World Units.
|
Vector3 |
getSide()
Calculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates
|
Vector3 |
getTarget()
Gets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates
|
Vector3 |
getUp()
Calculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates
|
boolean |
getZoomToFitOnAttach()
Gets whether or not the Camera should be zoomed to fit the parent scene bounds when it's attached
|
float |
getZoomToFitScaleFactor()
Gets the scale factor which is applied during calculation when Camera should be zoomed to fit the parent scene bounds
|
void |
setAspectRatio(float aspectRatio)
Sets the Aspect Ratio of the viewport, e.g.
|
void |
setCameraUpdateListener(ICameraUpdateListener cameraUpdateListener)
Sets the
ICameraUpdateListener which is called when this ICameraController is updated |
void |
setFarClip(float farClip)
Sets the Far Clipping distance of the camera.
|
void |
setFieldOfView(float fieldOfView)
Sets the Field of View Angle of the Camera in Degrees
|
void |
setNearClip(float nearClip)
Sets the Near Clipping distance of the camera.
|
void |
setOrbitalPitch(float orbitalPitch)
Sets the Pitch angle of the camera position relative to the target in DEGREES.
|
void |
setOrbitalYaw(float orbitalYaw)
Sets the Yaw angle of the camera position relative to the target in DEGREES.
|
void |
setOrthoHeight(float orthoHeight)
Sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal
|
void |
setOrthoWidth(float orthoWidth)
Sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal
|
void |
setPosition(Vector3 position)
Sets the Position of the Camera as an XYZ Vector3 in World Coordinates
|
void |
setPositionAndTarget(Vector3 position,
Vector3 target)
Sets the Position and the Target of the Camera as XYZ Vector3 in World Coordinates and
|
void |
setProjectionMode(CameraProjectionMode projectionMode)
Sets the Camera projection mode, e.g.
|
void |
setRadius(float radius)
Calculated Property: Sets the Radius distance of the camera to target in World Units.
|
void |
setTarget(Vector3 target)
Sets the Target of the Camera as an XYZ Vector3 in World Coordinates
|
void |
setZoomToFitOnAttach(boolean zoomToFitOnAttach)
Sets whether or not the Camera should be zoomed to fit the parent scene bounds when it's attached
|
void |
setZoomToFitScaleFactor(float zoomToFitScaleFactor)
Sets the scale factor which is applied during calculation when Camera should be zoomed to fit the parent scene bounds
|
void |
toOrthogonal()
Switches the camera to Orthogonal mode
|
void |
toPerspective()
Switches the camera to Perspective mode
|
void |
zoomToFit()
Zooms camera to fit bounding box of parent surface inside the viewport using current camera position as reset position
|
void |
zoomToFit(Vector3 resetPosition)
Zooms camera to fit bounding box of parent surface inside the viewport using specified reset position
|
attachTo, detach, isAttached
decrementSuspend, getIsSuspended, getUpdateSuspenderCount, resumeUpdates, suspendUpdates
update
Vector3 getPosition()
void setPosition(Vector3 position)
position
- The new position vectorVector3 getTarget()
void setTarget(Vector3 target)
target
- The new target vectorVector3 getUp()
Vector3 getForward()
Vector3 getSide()
float getFieldOfView()
void setFieldOfView(float fieldOfView)
fieldOfView
- The new field of view valuefloat getNearClip()
void setNearClip(float nearClip)
nearClip
- The new near clip valuefloat getFarClip()
void setFarClip(float farClip)
farClip
- The new far clip valuefloat getOrbitalYaw()
void setOrbitalYaw(float orbitalYaw)
orbitalYaw
- The new yaw valuefloat getOrbitalPitch()
void setOrbitalPitch(float orbitalPitch)
orbitalPitch
- The new pitch valuefloat getRadius()
void setRadius(float radius)
radius
- The new radius valuefloat getAspectRatio()
void setAspectRatio(float aspectRatio)
aspectRatio
- The new aspect rationCameraProjectionMode getProjectionMode()
void setProjectionMode(CameraProjectionMode projectionMode)
projectionMode
- The new projection modefloat getOrthoWidth()
void setOrthoWidth(float orthoWidth)
orthoWidth
- The new ortho widthfloat getOrthoHeight()
void setOrthoHeight(float orthoHeight)
orthoHeight
- The new ortho heightboolean getZoomToFitOnAttach()
void setZoomToFitOnAttach(boolean zoomToFitOnAttach)
zoomToFitOnAttach
- The new zoomToFitOnAttach
valuefloat getZoomToFitScaleFactor()
void setZoomToFitScaleFactor(float zoomToFitScaleFactor)
zoomToFitScaleFactor
- The new scale factorvoid setPositionAndTarget(Vector3 position, Vector3 target)
position
- The new positiontarget
- The new targetvoid toPerspective()
void toOrthogonal()
float calculateRadiusAndTargetToFit(Vector3 targetToFit)
targetToFit
- The camera target to fit the bounding box completely inside the viewport.void animateZoomToFit(long duration)
duration
- The duration of animation when zooming to fit bounding boxvoid animateZoomToFit(Vector3 resetPosition, long duration)
resetPosition
- The reset position to useduration
- The duration of animation when zooming to fit bounding boxvoid zoomToFit()
void zoomToFit(Vector3 resetPosition)
resetPosition
- The reset position to usevoid animate(Vector3 position, Vector3 target, long duration)
position
and target
position with specified durationposition
- The final position of cameratarget
- The final target of cameraduration
- The animation durationvoid setCameraUpdateListener(ICameraUpdateListener cameraUpdateListener)
ICameraUpdateListener
which is called when this ICameraController
is updatedcameraUpdateListener
- The listener to set