WPF Charting Documentation - SciChart WPF Charts SDK v5.x
CameraController Class Members
Properties  Methods  Events


The following tables list the members exposed by CameraController.

Public Constructors
 NameDescription
Public ConstructorCameraController ConstructorInitializes a new instance of the CameraController class.  
Top
Public Properties
 NameDescription
Public PropertyAspectRatioGets or sets the Aspect Ratio of the viewport, e.g. 1.333f suggests width is 1.333 * height  
Public PropertyCameraIdGets 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  
Public PropertyFarClipGets or sets the Far Clipping distance of the camera. Objects farther than this distance will be invisible to the camera  
Public PropertyFieldOfViewGets or sets the Field of View Angle of the Camera in Degrees  
Public PropertyForwardCalculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates  
Public PropertyIsAttachedINTERNAL USE ONLY: Gets or sets whether this camera is attached to the viewport  
Public PropertyIsSuspendedGets a value indicating whether updates for the target are currently suspended  
Public PropertyNearClipGets or sets the Near Clipping distance of the camera. Objects closer than this distance will be invisible to the camera  
Public PropertyOrbitalPitchGets 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  
Public PropertyOrbitalYawGets 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  
Public PropertyOrthoHeightGets or sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal  
Public PropertyOrthoWidthGets or sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal  
Public PropertyParentViewport3DGets or sets the parent IViewport3D where this camera is attached  
Public PropertyPositionGets or sets the Position of the Camera as an XYZ Vector3 in World Coordinates  
Public PropertyProjectionModeGets or sets the Camera projection mode, e.g. perspective or orthogonal  
Public PropertyRadiusCalculated 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  
Public PropertySideCalculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates  
Public PropertyTargetGets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates  
Public PropertyUpCalculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates  
Public PropertyUpGlobalCalculated Property: Gets the Normalized Global Up Vector equal to Vector3(0,1,0) in LH Coordinate system  
Public PropertyZoomToFitOnAttachWhen true, the Camera is zoomed to fit the parent SciChart3DSurface scene bounds on attached  
Top
Public Methods
 NameDescription
Public MethodAttachCameraToViewportINTERNAL USE: Attaches the camera to the viewport  
Public MethodCalculateRadiusToFitCalculates a Camera target and radius that will fit the bounding box completely inside the viewport. Uses a simple bounding-sphere algorithm  
Public MethodDecrementSuspendCalled by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called  
Public MethodLocalCoordinateToScreenSpaceConverts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices  
Public MethodResetToDefaultsResets the camera to default position, target and orientation  
Public MethodResumeUpdatesResumes updates on the target, intended to be called by IUpdateSuspender  
Public MethodScreenToWorldSpaceConverts a point in Screen space to a Vector3 in world space, given the specified distance from the screen  
Public MethodSuspendUpdatesSuspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued  
Public MethodToOrthogonalSwitches the camera to Orthogonal mode  
Public MethodToPerspectiveSwitches the camera to Perspective mode  
Public MethodWorldToScreenSpaceConverts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices  
Top
Protected Methods
 NameDescription
Protected MethodOnCameraUpdatedRaises the CameraUpdated event  
Protected MethodOnPropertyChangedOverloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from SciChart.Data.Model.BindableObject)
Protected MethodUpdateUpdates the internal camera used by the 3D scene  
Top
Extension Methods
 NameDescription
Public Extension MethodToEnumerable<T>Yields a single item, converting it to System.Collections.IEnumerable.
Public Extension MethodToStringArray2D<T>
Top
Public Events
 NameDescription
Public EventCameraUpdatedEvent raised whenever the Camera properties are updated and the parent requires a redraw  
Top
Protected Events
 NameDescription
Protected Event_propertyChangedOccurs when a property value changes. (Inherited from SciChart.Data.Model.BindableObject)
Top
See Also

Reference

CameraController Class
SciChart.Charting3D Namespace

 

 


SCICHART ® is a Registered Trademark in the UK, US and EU. Copyright SciChart Ltd 2011-2018.

Send Feedback