CameraMetadata Interface Reference
Metadata definitions for Camera. More...
Inheritance diagram for CameraMetadata:
Public Attributes | |
| DynamicPropertyType< Float > | AspectRatioProperty |
| Sets the aspect ratio of the camera. | |
| DynamicPropertyType< Vector4 > | AsymmetricFovProperty |
| Sets the field of view of the camera in degrees toward the left, right, up, and down. | |
| DynamicPropertyType< Boolean > | DisableAspectRatioProperty |
| Whether to use the aspect ratio setting from the viewport in render pass. | |
| DynamicPropertyType< Float > | FovProperty = new DynamicPropertyType<>("Camera.Fov", Float.class) |
| Sets the field of view of the camera in degrees. | |
| DynamicPropertyType< Matrix4x4Enums.FieldOfViewType > | FovTypeProperty |
| Sets the direction of the field of view: | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Camera") |
| Metaclass for Camera. | |
| DynamicPropertyType< CameraEnums.OrthogonalCoordinateSystem > | OrthogonalCoordinateSystemTypeProperty |
| Sets the type of the orthogonal coordinate system: | |
| DynamicPropertyType< Float > | OrthogonalPlaneHeightProperty |
| Sets the half width or half height of the view plane of a camera that uses the relative orthogonal coordinate system: | |
| DynamicPropertyType< CameraEnums.ProjectionType > | ProjectionTypeProperty |
| Sets the projection type of the camera: | |
| DynamicPropertyType< Float > | ZFarProperty = new DynamicPropertyType<>("Camera.ZFar", Float.class) |
| Sets the distance to the far clipping plane of the camera. | |
| DynamicPropertyType< Float > | ZNearProperty |
| Sets the distance to the near clipping plane of the camera. | |
 Public Attributes inherited from Node3DMetadata | |
| DynamicPropertyType< Matrix4x4 > | FinalTransformationProperty |
| The combined location, orientation and scale of the node and its ancestor nodes. | |
| DynamicPropertyType< Float > | FrustumCullMarginProperty |
| The margin of the frustum cull radius of the node. | |
| DynamicPropertyType< SRTValue3D > | LayoutTransformationProperty |
| The location, orientation and scale of the node relative to its parent node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node3D") |
| Metaclass for Node3D. | |
| DynamicPropertyType< Matrix4x4 > | PreviousFinalTransformationProperty |
| Final transformation (world matrix) from the previous frame, used for velocity buffer calculation. | |
| DynamicPropertyType< SRTValue3D > | RenderTransformationProperty |
| The location, orientation, and scale of the node relative to its parent node. | |
| Public Attributes inherited from NodeMetadata | |
| DynamicPropertyType< Float > | ActualDepthProperty |
| The calculated size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Float > | ActualHeightProperty |
| The calculated height of the node when used in a layout. | |
| DynamicPropertyType< Float > | ActualWidthProperty |
| The calculated width of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | ClipChildrenProperty |
| Sets whether to clip the child nodes of this node. | |
| DynamicPropertyType< NodeEnums.ContentStretch > | ContentStretchProperty |
| Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). | |
| DynamicPropertyType< Boolean > | CreatedFromKZBProperty |
| Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file. | |
| DynamicPropertyType< NodeEnums.DepthAlignment > | DepthAlignmentProperty |
| The alignment in depth direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | DepthMarginProperty |
| Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class) |
| The size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Boolean > | EffectivelyEnabledProperty |
| Indicates whether this node and its ancestor nodes are enabled. | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether this node is enabled. | |
| DynamicPropertyType< Boolean > | FocusableProperty |
| Indicates whether the node can receive focus. | |
| DynamicPropertyType< Boolean > | FocusedProperty |
| Indicates whether the node has the key focus. | |
| DynamicPropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a node: | |
| DynamicPropertyType< Resource > | FontFamilyProperty |
| The font family used to render the text. | |
| DynamicPropertyType< Float > | HeightProperty |
| The height of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | HitTestableContainerProperty |
| When enabled, Kanzi uses the layout bounds as geometry for hit testing. | |
| DynamicPropertyType< Boolean > | HitTestableProperty |
| When enabled, the node can be hit tested. | |
| DynamicPropertyType< NodeEnums.HorizontalAlignment > | HorizontalAlignmentProperty |
| The alignment in horizontal direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Boolean > | HoverProperty |
| Indicates whether a node is the foremost hit testable node under the cursor. | |
| DynamicPropertyType< String > | LocaleProperty |
| The locale of the node. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node") |
| Metaclass for Node. | |
| DynamicPropertyType< String > | NameProperty = new DynamicPropertyType<>("Node.Name", String.class) |
| Node name. | |
| DynamicPropertyType< Float > | OpacityProperty |
| Opacity of the node. | |
| DynamicPropertyType< String > | PathProperty = new DynamicPropertyType<>("Node.Path", String.class) |
| Full path to the node. | |
| DynamicPropertyType< Float > | Projection2DTo3DScaleProperty |
| Sets the scale factor to project pixels to 3D size. | |
| DynamicPropertyType< Resource > | StateManagerProperty |
| Sets the State Manager to the node. | |
| DynamicPropertyType< Resource > | StyleProperty |
| Sets a style to the node. | |
| DynamicPropertyType< NodeEnums.VerticalAlignment > | VerticalAlignmentProperty |
| The alignment in vertical direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | VisibleAmountInParentProperty |
| Sets the amount the node is inside its parent. | |
| DynamicPropertyType< Boolean > | VisibleProperty |
| When disabled, Kanzi does not render the node. | |
| DynamicPropertyType< Float > | WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class) |
| The width of the node when used in a layout. | |
Detailed Description
Metadata definitions for Camera.
Member Data Documentation
◆ AspectRatioProperty
| DynamicPropertyType<Float> AspectRatioProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.AspectRatio", Float.class)
Sets the aspect ratio of the camera.
◆ AsymmetricFovProperty
| DynamicPropertyType<Vector4> AsymmetricFovProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.AsymmetricFov", Vector4.class)
Sets the field of view of the camera in degrees toward the left, right, up, and down.
Angles to the right of the center and upwards of the center are positive.
To use this property, set the Projection Type to Asymmetric perspective.
◆ DisableAspectRatioProperty
| DynamicPropertyType<Boolean> DisableAspectRatioProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.DisableAspectRatio", Boolean.class)
Whether to use the aspect ratio setting from the viewport in render pass.
When disabled, you can set the aspect ratio in the camera.
◆ FovTypeProperty
| DynamicPropertyType<Matrix4x4Enums.FieldOfViewType> FovTypeProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.FovType", Matrix4x4Enums.FieldOfViewType.class)
Sets the direction of the field of view:
- Y FOV sets the field of view along the y axis. This is the default.
- X FOV sets the field of view along the x axis.
◆ OrthogonalCoordinateSystemTypeProperty
| DynamicPropertyType<CameraEnums.OrthogonalCoordinateSystem> OrthogonalCoordinateSystemTypeProperty |
Initial value:
= new DynamicPropertyType<>(
"Camera.OrthogonalCoordinateSystemType", CameraEnums.OrthogonalCoordinateSystem.class)
Sets the type of the orthogonal coordinate system:
- Relative sets the camera to display an area whose width is scaled with the value of the Orthogonal Plane Size property. This is the default.
- Absolute sets the camera to use pixel coordinates.
◆ OrthogonalPlaneHeightProperty
| DynamicPropertyType<Float> OrthogonalPlaneHeightProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.OrthogonalPlaneHeight", Float.class)
Sets the half width or half height of the view plane of a camera that uses the relative orthogonal coordinate system:
- When FOV Type is Y FOV (default value), the height.
- When FOV Type is X FOV, the width.
The default value is 1.0.
◆ ProjectionTypeProperty
| DynamicPropertyType<CameraEnums.ProjectionType> ProjectionTypeProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.ProjectionType", CameraEnums.ProjectionType.class)
Sets the projection type of the camera:
- Perspective projection shows objects closer to the camera larger than those that are further away. This is the default.
- Asymmetric perspective projection lets you use the Asymmetric FOV property to control the field of view of each angle of a perspective projection.
- Orthographic projection shows a 2D view of a 3D scene without providing a sense of depth.
◆ ZFarProperty
| DynamicPropertyType<Float> ZFarProperty = new DynamicPropertyType<>("Camera.ZFar", Float.class) |
Sets the distance to the far clipping plane of the camera.
The camera shows only the objects that are closer than the value set in this property.
◆ ZNearProperty
| DynamicPropertyType<Float> ZNearProperty |
Initial value:
=
new DynamicPropertyType<>("Camera.ZNear", Float.class)
Sets the distance to the near clipping plane of the camera.
The camera shows only the objects that are farther away than the value set in this property.