Camera

Camera class

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

Methods

constructor

Name	Description
constructor()	Initializes a new instance of the Camera class.

Result:

---

constructor_overload

Name	Description
constructor_overload(projectionType)	Initializes a new instance of the Camera class.

Parameters:

Name	Type	Description
projectionType	ProjectionType	ProjectionType

Result:

---

constructor_overload$2{#constructor_overload$2}

Name	Description
constructor_overload$2(name)	Initializes a new instance of the Camera class.

Parameters:

Name	Type	Description
name	String	Name.

Result:

---

constructor_overload$3{#constructor_overload$3}

Name	Description
constructor_overload$3(name, projectionType)	Initializes a new instance of the Camera class.

Parameters:

Name	Type	Description
name	String	Name.
projectionType	ProjectionType	ProjectionType

Result:

---

getApertureMode

Name	Description
getApertureMode()	Gets or sets the camera’s aperture mode The value of the property is ApertureMode integer constant.

Result:

---

setApertureMode

Name	Description
setApertureMode(value)	Gets or sets the camera’s aperture mode The value of the property is ApertureMode integer constant.

Result:

---

getFieldOfView

Name	Description
getFieldOfView()	Gets or sets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL

Result:

---

setFieldOfView

Name	Description
setFieldOfView(value)	Gets or sets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL

Result:

---

getFieldOfViewX

Name	Description
getFieldOfViewX()	Gets or sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT

Result:

---

setFieldOfViewX

Name	Description
setFieldOfViewX(value)	Gets or sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT

Result:

---

getFieldOfViewY

Name	Description
getFieldOfViewY()	Gets or sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT

Result:

---

setFieldOfViewY

Name	Description
setFieldOfViewY(value)	Gets or sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT

Result:

---

getWidth

Name	Description
getWidth()	Gets or sets the view plane’s width measured in inches

Result:

---

setWidth

Name	Description
setWidth(value)	Gets or sets the view plane’s width measured in inches

Result:

---

getHeight

Name	Description
getHeight()	Gets or sets the view plane’s height measured in inches

Result:

---

setHeight

Name	Description
setHeight(value)	Gets or sets the view plane’s height measured in inches

Result:

---

getAspectRatio

Name	Description
getAspectRatio()	Gets or sets the view plane aspect ratio.

Result:

---

setAspectRatio

Name	Description
setAspectRatio(value)	Gets or sets the view plane aspect ratio.

Result:

---

getMagnification

Name	Description
getMagnification()	Gets or sets the magnification used in orthographic camera

Result:

---

setMagnification

Name	Description
setMagnification(value)	Gets or sets the magnification used in orthographic camera

Result:

---

getProjectionType

Name	Description
getProjectionType()	Gets or sets the camera’s projection type. By default the perspective projection is used. The value of the property is ProjectionType integer constant.

Result:

---

setProjectionType

Name	Description
setProjectionType(value)	Gets or sets the camera’s projection type. By default the perspective projection is used. The value of the property is ProjectionType integer constant.

Result:

---

getRotationMode

Name	Description
getRotationMode()	Gets or sets the frustum’s orientation mode This property only works when the Target is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property LookAt Otherwise the LookAt is always calculated by the DirectionThe value of the property is RotationMode integer constant.

Result:

---

setRotationMode

Name	Description
setRotationMode(value)	Gets or sets the frustum’s orientation mode This property only works when the Target is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property LookAt Otherwise the LookAt is always calculated by the DirectionThe value of the property is RotationMode integer constant.

Result:

---

getNearPlane

Name	Description
getNearPlane()	Gets or sets the frustum’s near plane distance.

Result:

---

setNearPlane

Name	Description
setNearPlane(value)	Gets or sets the frustum’s near plane distance.

Result:

---

getFarPlane

Name	Description
getFarPlane()	Gets or sets the frustum’s far plane distance.

Result:

---

setFarPlane

Name	Description
setFarPlane(value)	Gets or sets the frustum’s far plane distance.

Result:

---

getAspect

Name	Description
getAspect()	Gets or sets the aspect ratio of the frustum

Result:

---

setAspect

Name	Description
setAspect(value)	Gets or sets the aspect ratio of the frustum

Result:

---

getOrthoHeight

Name	Description
getOrthoHeight()	Gets or sets the height when frustum in orthographic projection.

Result:

---

setOrthoHeight

Name	Description
setOrthoHeight(value)	Gets or sets the height when frustum in orthographic projection.

Result:

---

getUp

Name	Description
getUp()	Gets or sets the up direction of the camera

Result:

---

setUp

Name	Description
setUp(value)	Gets or sets the up direction of the camera

Result:

---

getLookAt

Name	Description
getLookAt()	Gets or sets the the interested position that the camera is looking at.

Result:

---

setLookAt

Name	Description
setLookAt(value)	Gets or sets the the interested position that the camera is looking at.

Result:

---

getDirection

Name	Description
getDirection()	Gets or sets the direction that the camera is looking at. Changes on this property will also affects the LookAt and Target.

Result:

---

setDirection

Name	Description
setDirection(value)	Gets or sets the direction that the camera is looking at. Changes on this property will also affects the LookAt and Target.

Result:

---

getTarget

Name	Description
getTarget()	Gets or sets the target that the camera is looking at. If the user supports this property, it should be prior to LookAt property.

Result:

---

setTarget

Name	Description
setTarget(value)	Gets or sets the target that the camera is looking at. If the user supports this property, it should be prior to LookAt property.

Result:

---

getParentNodes

Name	Description
getParentNodes()	Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing The nodes.

Result:

---

getExcluded

Name	Description
getExcluded()	Gets or sets whether to exclude this entity during exporting.

Result:

---

setExcluded

Name	Description
setExcluded(value)	Gets or sets whether to exclude this entity during exporting.

Result:

---

getParentNode

Name	Description
getParentNode()	Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:

---

setParentNode

Name	Description
setParentNode(value)	Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:

---

getScene

Name	Description
getScene()	Gets the scene that this object belongs to

Result:

---

getName

Name	Description
getName()	Gets or sets the name. The name.

Result:

---

setName

Name	Description
setName(value)	Gets or sets the name. The name.

Result:

---

getProperties

Name	Description
getProperties()	Gets the collection of all properties.

Result:

---

moveForward

Name	Description
moveForward(distance)	Move camera forward towards its direction or target.

Parameters:

Name	Type	Description
distance	Number	How long to move forward

Result:

---

getBoundingBox

Name	Description
getBoundingBox()	Gets the bounding box of current entity in its object space coordinate system.

Result:

---

getEntityRendererKey

Name	Description
getEntityRendererKey()	Gets the key of the entity renderer registered in the renderer

Result: EntityRendererKey

---

removeProperty

Name	Description
removeProperty(property)	Removes a dynamic property.

Parameters:

Name	Type	Description
property	Property	Which property to remove

Result: boolean

---

removeProperty

Name	Description
removeProperty(property)	Remove the specified property identified by name

Parameters:

Name	Type	Description
propert	String	null

Result: boolean

---

getProperty

Name	Description
getProperty(property)	Get the value of specified property

Parameters:

Name	Type	Description
property	String	Property name

Result: Object

---

setProperty

Name	Description
setProperty(property, value)	Sets the value of specified property

Parameters:

Name	Type	Description
property	String	Property name
value	Object	The value of the property

Result: Object

---

findProperty

Name	Description
findProperty(propertyName)	Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)

Parameters:

Name	Type	Description
propertyName	String	Property name.

Result: Property

---