Camera

Camera class

The camera describes the eye point of the viewer looking at the scene.

public class Camera : Frustum

Constructors

Name Description
Camera() Initializes a new instance of the Camera class.
Camera(ProjectionType) Initializes a new instance of the Camera class.
Camera(string) Initializes a new instance of the Camera class.
Camera(string, ProjectionType) Initializes a new instance of the Camera class.

Properties

Name Description
ApertureMode { get; set; } Gets or sets the camera’s aperture mode
Aspect { get; set; } Gets or sets the aspect ratio of the frustum
AspectRatio { get; set; } Gets or sets the view plane aspect ratio.
Direction { get; set; } Gets or sets the direction that the camera is looking at. Changes on this property will also affects the LookAt and Target.
Excluded { get; set; } Gets or sets whether to exclude this entity during exporting.
FarPlane { get; set; } Gets or sets the frustum’s far plane distance.
FieldOfView { get; set; } Gets or sets the camera’s field of view in degrees, this property is used only when ApertureMode is Horizontal or Vertical
FieldOfViewX { get; set; } Gets or sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is HorizAndVert
FieldOfViewY { get; set; } Gets or sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is HorizAndVert
Height { get; set; } Gets or sets the view plane’s height measured in inches
LookAt { get; set; } Gets or sets the the interested position that the camera is looking at.
Magnification { get; set; } Gets or sets the magnification used in orthographic camera
virtual Name { get; set; } Gets or sets the name.
NearPlane { get; set; } Gets or sets the frustum’s near plane distance.
OrthoHeight { get; set; } Gets or sets the height when frustum in orthographic projection.
ParentNode { get; set; } Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
ParentNodes { get; } Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
ProjectionType { get; set; } Gets or sets the camera’s projection type. By default the perspective projection is used.
Properties { get; } Gets the collection of all properties.
RotationMode { get; set; } Gets or sets the frustum’s orientation mode This property only works when the Target is null. If the value is FixedTarget, the direction is always calculated by the property LookAt Otherwise the LookAt is always calculated by the Direction
Scene { get; } Gets the scene that this object belongs to
Target { get; set; } Gets or sets the target that the camera is looking at. If the user supports this property, it should be prior to LookAt property.
Up { get; set; } Gets or sets the up direction of the camera
Width { get; set; } Gets or sets the view plane’s width measured in inches

Methods

Name Description
FindProperty(string) Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)
GetBoundingBox() Gets the bounding box of current entity in its object space coordinate system.
virtual GetEntityRendererKey() Gets the key of the entity renderer registered in the renderer
GetProperty(string) Get the value of specified property
MoveForward(double) Move camera forward towards its direction or target.
RemoveProperty(Property) Removes a dynamic property.
RemoveProperty(string) Remove the specified property identified by name
SetProperty(string, object) Sets the value of specified property

See Also