Camera
Inheritance: java.lang.Object, com.aspose.threed.A3DObject, com.aspose.threed.SceneObject, com.aspose.threed.Entity, com.aspose.threed.Frustum
All Implemented Interfaces: com.aspose.threed.IOrientable
public class Camera extends Frustum implements IOrientable
The camera describes the eye point of the viewer looking at the scene.
Constructors
| Constructor | Description |
|---|---|
| Camera() | Initializes a new instance of the Camera class. |
| Camera(ProjectionType projectionType) | Initializes a new instance of the Camera class. |
| Camera(String name) | Initializes a new instance of the Camera class. |
| Camera(String name, ProjectionType projectionType) | Initializes a new instance of the Camera class. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| findProperty(String propertyName) | Finds the property. |
| getApertureMode() | Gets the camera’s aperture mode |
| getAspect() | Gets the aspect ratio of the frustum |
| getAspectRatio() | Gets the view plane aspect ratio. |
| getBoundingBox() | Gets the bounding box of current entity in its object space coordinate system. |
| getClass() | |
| getDirection() | Gets the direction that the camera is looking at. |
| getEntityRendererKey() | Gets the key of the entity renderer registered in the renderer |
| getExcluded() | Gets whether to exclude this entity during exporting. |
| getFarPlane() | Gets the frustum’s far plane distance. |
| getFieldOfView() | Gets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL |
| getFieldOfViewX() | Gets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT |
| getFieldOfViewY() | Gets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT |
| getHeight() | Gets the view plane’s height measured in inches |
| getLookAt() | Gets the the interested position that the camera is looking at. |
| getMagnification() | Gets the magnification used in orthographic camera |
| getName() | Gets the name. |
| getNearPlane() | Gets the frustum’s near plane distance. |
| getOrthoHeight() | Gets the height when frustum in orthographic projection. |
| getParentNode() | Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. |
| getParentNodes() | Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing |
| getProjectionType() | Gets the camera’s projection type. |
| getProperties() | Gets the collection of all properties. |
| getProperty(String property) | Get the value of specified property |
| getRotationMode() | Gets the frustum’s orientation mode This property only works when the getTarget is null. |
| getScene() | Gets the scene that this object belongs to |
| getTarget() | Gets the target that the camera is looking at. |
| getUp() | Gets the up direction of the camera |
| getWidth() | Gets the view plane’s width measured in inches |
| hashCode() | |
| moveForward(double distance) | Move camera forward towards its direction or target. |
| notify() | |
| notifyAll() | |
| removeProperty(Property property) | Removes a dynamic property. |
| removeProperty(String property) | Remove the specified property identified by name |
| setApertureMode(ApertureMode value) | Sets the camera’s aperture mode |
| setAspect(double value) | Sets the aspect ratio of the frustum |
| setAspectRatio(double value) | Sets the view plane aspect ratio. |
| setDirection(Vector3 value) | Sets the direction that the camera is looking at. |
| setExcluded(boolean value) | Sets whether to exclude this entity during exporting. |
| setFarPlane(double value) | Sets the frustum’s far plane distance. |
| setFieldOfView(double value) | Sets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL |
| setFieldOfViewX(double value) | Sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT |
| setFieldOfViewY(double value) | Sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT |
| setHeight(double value) | Sets the view plane’s height measured in inches |
| setLookAt(Vector3 value) | Sets the the interested position that the camera is looking at. |
| setMagnification(Vector2 value) | Sets the magnification used in orthographic camera |
| setName(String value) | Sets the name. |
| setNearPlane(double value) | Sets the frustum’s near plane distance. |
| setOrthoHeight(double value) | Sets the height when frustum in orthographic projection. |
| setParentNode(Node value) | Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. |
| setProjectionType(ProjectionType value) | Sets the camera’s projection type. |
| setProperty(String property, Object value) | Sets the value of specified property |
| setRotationMode(RotationMode value) | Sets the frustum’s orientation mode This property only works when the getTarget is null. |
| setTarget(Node value) | Sets the target that the camera is looking at. |
| setUp(Vector3 value) | Sets the up direction of the camera |
| setWidth(double value) | Sets the view plane’s width measured in inches |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
Camera()
public Camera()
Initializes a new instance of the Camera class.
Camera(ProjectionType projectionType)
public Camera(ProjectionType projectionType)
Initializes a new instance of the Camera class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| projectionType | ProjectionType | Projection type. |
Camera(String name)
public Camera(String name)
Initializes a new instance of the Camera class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name. |
Camera(String name, ProjectionType projectionType)
public Camera(String name, ProjectionType projectionType)
Initializes a new instance of the Camera class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name. |
| projectionType | ProjectionType | Projection type. |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
findProperty(String propertyName)
public Property findProperty(String propertyName)
Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| propertyName | java.lang.String | Property name. |
Returns: Property - The property.
getApertureMode()
public ApertureMode getApertureMode()
Gets the camera’s aperture mode
Returns: ApertureMode
getAspect()
public double getAspect()
Gets the aspect ratio of the frustum
Returns: double
getAspectRatio()
public double getAspectRatio()
Gets the view plane aspect ratio.
Returns: double
getBoundingBox()
public BoundingBox getBoundingBox()
Gets the bounding box of current entity in its object space coordinate system. Example: The following code shows how to calculate the bounding box of a shape
Entity entity = new Sphere();
entity.setRadius(10);
var bbox = entity.getBoundingBox();
System.out.printf("The bounding box of the entity is %s ~ %s", bbox.getMinimum(), bbox.getMaximum());
Returns: BoundingBox
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getDirection()
public Vector3 getDirection()
Gets the direction that the camera is looking at. Changes on this property will also affects the getLookAt and getTarget.
Returns: Vector3
getEntityRendererKey()
public EntityRendererKey getEntityRendererKey()
Gets the key of the entity renderer registered in the renderer
Returns: EntityRendererKey
getExcluded()
public boolean getExcluded()
Gets whether to exclude this entity during exporting.
Returns: boolean
getFarPlane()
public double getFarPlane()
Gets the frustum’s far plane distance.
Returns: double
getFieldOfView()
public double getFieldOfView()
Gets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL
Returns: double
getFieldOfViewX()
public double getFieldOfViewX()
Gets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
Returns: double
getFieldOfViewY()
public double getFieldOfViewY()
Gets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
Returns: double
getHeight()
public double getHeight()
Gets the view plane’s height measured in inches
Returns: double
getLookAt()
public Vector3 getLookAt()
Gets the the interested position that the camera is looking at.
Returns: Vector3
getMagnification()
public Vector2 getMagnification()
Gets the magnification used in orthographic camera
Returns: Vector2
getName()
public String getName()
Gets the name.
Returns: java.lang.String
getNearPlane()
public double getNearPlane()
Gets the frustum’s near plane distance.
Returns: double
getOrthoHeight()
public double getOrthoHeight()
Gets the height when frustum in orthographic projection.
Returns: double
getParentNode()
public Node getParentNode()
Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
Returns: Node
getParentNodes()
public ArrayList<Node> getParentNodes()
Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
Returns: java.util.ArrayList<com.aspose.threed.Node>
getProjectionType()
public ProjectionType getProjectionType()
Gets the camera’s projection type. By default the perspective projection is used.
Returns: ProjectionType
getProperties()
public PropertyCollection getProperties()
Gets the collection of all properties.
Returns: PropertyCollection
getProperty(String property)
public Object getProperty(String property)
Get the value of specified property
Parameters:
| Parameter | Type | Description |
|---|---|---|
| property | java.lang.String | Property name |
Returns: java.lang.Object - The value of the found property
getRotationMode()
public RotationMode getRotationMode()
Gets the frustum’s orientation mode This property only works when the getTarget is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property getLookAt Otherwise the getLookAt is always calculated by the getDirection
Returns: RotationMode
getScene()
public Scene getScene()
Gets the scene that this object belongs to
Returns: Scene
getTarget()
public Node getTarget()
Gets the target that the camera is looking at. If the user supports this property, it should be prior to getLookAt property.
Returns: Node
getUp()
public Vector3 getUp()
Gets the up direction of the camera
Returns: Vector3
getWidth()
public double getWidth()
Gets the view plane’s width measured in inches
Returns: double
hashCode()
public native int hashCode()
Returns: int
moveForward(double distance)
public void moveForward(double distance)
Move camera forward towards its direction or target.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| distance | double | How long to move forward |
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
removeProperty(Property property)
public boolean removeProperty(Property property)
Removes a dynamic property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| property | Property | Which property to remove |
Returns: boolean - true if the property is successfully removed
removeProperty(String property)
public boolean removeProperty(String property)
Remove the specified property identified by name
Parameters:
| Parameter | Type | Description |
|---|---|---|
| property | java.lang.String |
Returns: boolean
setApertureMode(ApertureMode value)
public void setApertureMode(ApertureMode value)
Sets the camera’s aperture mode
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ApertureMode | New value |
setAspect(double value)
public void setAspect(double value)
Sets the aspect ratio of the frustum
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setAspectRatio(double value)
public void setAspectRatio(double value)
Sets the view plane aspect ratio.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setDirection(Vector3 value)
public void setDirection(Vector3 value)
Sets the direction that the camera is looking at. Changes on this property will also affects the getLookAt and getTarget.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Vector3 | New value |
setExcluded(boolean value)
public void setExcluded(boolean value)
Sets whether to exclude this entity during exporting.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | New value |
setFarPlane(double value)
public void setFarPlane(double value)
Sets the frustum’s far plane distance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setFieldOfView(double value)
public void setFieldOfView(double value)
Sets the camera’s field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZONTAL or ApertureMode.VERTICAL
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setFieldOfViewX(double value)
public void setFieldOfViewX(double value)
Sets the camera’s horizontal field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setFieldOfViewY(double value)
public void setFieldOfViewY(double value)
Sets the camera’s vertical field of view in degrees, this property is used only when ApertureMode is ApertureMode.HORIZ_AND_VERT
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setHeight(double value)
public void setHeight(double value)
Sets the view plane’s height measured in inches
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setLookAt(Vector3 value)
public void setLookAt(Vector3 value)
Sets the the interested position that the camera is looking at.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Vector3 | New value |
setMagnification(Vector2 value)
public void setMagnification(Vector2 value)
Sets the magnification used in orthographic camera
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Vector2 | New value |
setName(String value)
public void setName(String value)
Sets the name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | New value |
setNearPlane(double value)
public void setNearPlane(double value)
Sets the frustum’s near plane distance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setOrthoHeight(double value)
public void setOrthoHeight(double value)
Sets the height when frustum in orthographic projection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
setParentNode(Node value)
public void setParentNode(Node value)
Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Node | New value |
setProjectionType(ProjectionType value)
public void setProjectionType(ProjectionType value)
Sets the camera’s projection type. By default the perspective projection is used.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ProjectionType | New value |
setProperty(String property, Object value)
public void setProperty(String property, Object value)
Sets the value of specified property
Parameters:
| Parameter | Type | Description |
|---|---|---|
| property | java.lang.String | Property name |
| value | java.lang.Object | The value of the property |
setRotationMode(RotationMode value)
public void setRotationMode(RotationMode value)
Sets the frustum’s orientation mode This property only works when the getTarget is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property getLookAt Otherwise the getLookAt is always calculated by the getDirection
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | RotationMode | New value |
setTarget(Node value)
public void setTarget(Node value)
Sets the target that the camera is looking at. If the user supports this property, it should be prior to getLookAt property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Node | New value |
setUp(Vector3 value)
public void setUp(Vector3 value)
Sets the up direction of the camera
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Vector3 | New value |
setWidth(double value)
public void setWidth(double value)
Sets the view plane’s width measured in inches
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | New value |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |