Camera class

Camera class

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

Inheritance: CameraFrustumEntitySceneObjectA3DObject

The Camera type exposes the following members:

Constructors

ConstructorDescription
initInitializes a new instance of the Camera class.
initInitializes a new instance of the Camera class.
initInitializes a new instance of the Camera class.
initInitializes a new instance of the Camera class.

Properties

PropertyDescription
nameGets or sets the name.
propertiesGets the collection of all properties.
sceneGets the scene that this object belongs to
parent_nodesGets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
excludedGets or sets whether to exclude this entity during exporting.
parent_nodeGets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
rotation_modeGets or sets the frustum’s orientation mode
This property only works when the Frustum.target is null.
If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property Frustum.look_at
Otherwise the Frustum.look_at is always calculated by the Frustum.direction
near_planeGets or sets the frustum’s near plane distance.
far_planeGets or sets the frustum’s far plane distance.
aspectGets or sets the aspect ratio of the frustum
ortho_heightGets or sets the height when frustum in orthographic projection.
upGets or sets the up direction of the camera
look_atGets or sets the the interested position that the camera is looking at.
directionGets or sets the direction that the camera is looking at.
Changes on this property will also affects the Frustum.look_at and Frustum.target.
targetGets or sets the target that the camera is looking at.
If the user supports this property, it should be prior to Frustum.look_at property.
aperture_modeGets or sets the camera’s aperture mode
field_of_viewGets or sets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL
field_of_view_xGets or sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
field_of_view_yGets or sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
widthGets or sets the view plane’s width measured in inches
heightGets or sets the view plane’s height measured in inches
aspect_ratioGets or sets the view plane aspect ratio.
magnificationGets or sets the magnification used in orthographic camera
projection_typeGets or sets the camera’s projection type.
By default the perspective projection is used.

Methods

MethodDescription
remove_propertyRemoves a dynamic property.
remove_propertyRemove the specified property identified by name
get_propertyGet the value of specified property
set_propertySets the value of specified property
find_propertyFinds the property.
It can be a dynamic property (Created by CreateDynamicProperty/SetProperty)
or native property(Identified by its name)
get_bounding_boxGets the bounding box of current entity in its object space coordinate system.
get_entity_renderer_keyGets the key of the entity renderer registered in the renderer
move_forwardMove camera forward towards its direction or target.

See Also