Frustum

Frustum class

The base class of Camera and Light @hideconstructor

Methods

getRotationMode

NameDescription
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

NameDescription
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

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

Result:


setNearPlane

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

Result:


getFarPlane

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

Result:


setFarPlane

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

Result:


getAspect

NameDescription
getAspect()Gets or sets the aspect ratio of the frustum

Result:


setAspect

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

Result:


getOrthoHeight

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

Result:


setOrthoHeight

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

Result:


getUp

NameDescription
getUp()Gets or sets the up direction of the camera

Result:


setUp

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

Result:


getLookAt

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

Result:


setLookAt

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

Result:


getDirection

NameDescription
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

NameDescription
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

NameDescription
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

NameDescription
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

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

Result:


getExcluded

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

Result:


setExcluded

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

Result:


getParentNode

NameDescription
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

NameDescription
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

NameDescription
getScene()Gets the scene that this object belongs to

Result:


getName

NameDescription
getName()Gets or sets the name. The name.

Result:


setName

NameDescription
setName(value)Gets or sets the name. The name.

Result:


getProperties

NameDescription
getProperties()Gets the collection of all properties.

Result:


getBoundingBox

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

Result:


getEntityRendererKey

NameDescription
getEntityRendererKey()Gets the key of the entity renderer registered in the renderer

Result: EntityRendererKey


removeProperty

NameDescription
removeProperty(property)Removes a dynamic property.

Parameters:

NameTypeDescription
propertyPropertyWhich property to remove

Result: boolean


removeProperty

NameDescription
removeProperty(property)Remove the specified property identified by name

Parameters:

NameTypeDescription
propertStringnull

Result: boolean


getProperty

NameDescription
getProperty(property)Get the value of specified property

Parameters:

NameTypeDescription
propertyStringProperty name

Result: Object


setProperty

NameDescription
setProperty(property, value)Sets the value of specified property

Parameters:

NameTypeDescription
propertyStringProperty name
valueObjectThe value of the property

Result: Object


findProperty

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

Parameters:

NameTypeDescription
propertyNameStringProperty name.

Result: Property