Kanzi  3.9.7
Java API
CameraMetadata Interface Reference

Metadata definitions for Camera. More...

Inheritance diagram for CameraMetadata:
[legend]

Public Attributes

DynamicPropertyType< Float > AspectRatioProperty
 The aspect ratio of the camera. More...
 
DynamicPropertyType< Vector4AsymmetricFovProperty
 The field of view of the camera in degrees. More...
 
DynamicPropertyType< Boolean > DisableAspectRatioProperty
 Whether to use the aspect ratio setting from the viewport in render pass. More...
 
DynamicPropertyType< Float > FovProperty = new DynamicPropertyType<>("Camera.Fov", Float.class)
 The field of view of the camera in degrees.
 
DynamicPropertyType< Matrix4x4Enums.FieldOfViewTypeFovTypeProperty
 Defines the direction of the field of view to either x or y. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Camera")
 Metaclass for Camera.
 
DynamicPropertyType< CameraEnums.OrthogonalCoordinateSystemOrthogonalCoordinateSystemTypeProperty
 Defines the type of the orthogonal coordinate system. More...
 
DynamicPropertyType< Float > OrthogonalPlaneHeightProperty
 The value used for scaling the view area of a relative orthographic camera. More...
 
DynamicPropertyType< CameraEnums.ProjectionTypeProjectionTypeProperty
 Defines the camera type to either perspective or orthographic camera. More...
 
DynamicPropertyType< Float > ZFarProperty = new DynamicPropertyType<>("Camera.ZFar", Float.class)
 The distance of the camera far clipping plane. More...
 
DynamicPropertyType< Float > ZNearProperty
 The distance of the camera near clipping plane. More...
 
- Public Attributes inherited from Node3DMetadata
DynamicPropertyType< Matrix4x4FinalTransformationProperty
 The combined location, orientation and scale of the node and its ancestor nodes. More...
 
DynamicPropertyType< Float > FrustumCullMarginProperty
 The margin of the frustum cull radius of the node. More...
 
DynamicPropertyType< SRTValue3DLayoutTransformationProperty
 The location, orientation and scale of the node relative to its parent node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node3D")
 Metaclass for Node3D.
 
DynamicPropertyType< SRTValue3DRenderTransformationProperty
 The location, orientation, and scale of the node relative to its parent node. More...
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< Float > ActualDepthProperty
 The calculated size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Float > ActualHeightProperty
 The calculated height of the node when used in a layout. More...
 
DynamicPropertyType< Float > ActualWidthProperty
 The calculated width of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > ClipChildrenProperty
 Sets whether to clip the child nodes of this node. More...
 
DynamicPropertyType< NodeEnums.ContentStretchContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). More...
 
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. More...
 
DynamicPropertyType< NodeEnums.DepthAlignmentDepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Boolean > EffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled. More...
 
DynamicPropertyType< Boolean > EnabledProperty
 Whether this node is enabled. More...
 
DynamicPropertyType< Boolean > FocusableProperty
 Indicates whether the node can receive focus. More...
 
DynamicPropertyType< Boolean > FocusedProperty
 Indicates whether the node has the key focus. More...
 
DynamicPropertyType< FocusStateFocusStateProperty
 Reports the focus state of a node: More...
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text. More...
 
DynamicPropertyType< Float > HeightProperty
 The height of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > HitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing. More...
 
DynamicPropertyType< Boolean > HitTestableProperty
 When enabled, the node can be hit tested. More...
 
DynamicPropertyType< NodeEnums.HorizontalAlignmentHorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Boolean > HoverProperty
 Indicates whether a node is the foremost hit testable node under the cursor. More...
 
DynamicPropertyType< String > LocaleProperty
 The locale of the node. More...
 
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. More...
 
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. More...
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node. More...
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node. More...
 
DynamicPropertyType< NodeEnums.VerticalAlignmentVerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > VisibleAmountInParentProperty
 Sets the amount the node is inside its parent. More...
 
DynamicPropertyType< Boolean > VisibleProperty
 When disabled, Kanzi does not render the node. More...
 
DynamicPropertyType< Float > WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout. More...
 

Detailed Description

Metadata definitions for Camera.

Member Data Documentation

DynamicPropertyType<Float> AspectRatioProperty
Initial value:
=
new DynamicPropertyType<>("Camera.AspectRatio", Float.class)

The aspect ratio of the camera.

DynamicPropertyType<Vector4> AsymmetricFovProperty
Initial value:
=
new DynamicPropertyType<>("Camera.AsymmetricFov", Vector4.class)

The field of view of the camera in degrees.

Angles are in order left, right, up, and down. Angles to the right of the center and upwards of the center are positive.

DynamicPropertyType<Boolean> DisableAspectRatioProperty
Initial value:
=
new DynamicPropertyType<>("Camera.DisableAspectRatio", Boolean.class)

Whether to use the aspect ratio setting from the viewport in render pass.

If not, you can set the aspect ratio in the camera.

Initial value:
=
new DynamicPropertyType<>("Camera.FovType", Matrix4x4Enums.FieldOfViewType.class)

Defines the direction of the field of view to either x or y.

DynamicPropertyType<CameraEnums.OrthogonalCoordinateSystem> OrthogonalCoordinateSystemTypeProperty
Initial value:
= new DynamicPropertyType<>(
"Camera.OrthogonalCoordinateSystemType", CameraEnums.OrthogonalCoordinateSystem.class)

Defines the type of the orthogonal coordinate system.

In the absolute mode the camera uses pixel coordinates. In the relative mode the camera displays an area whose width is -1..1 scaled with the value set by the Orthogonal Plane Size property.

DynamicPropertyType<Float> OrthogonalPlaneHeightProperty
Initial value:
=
new DynamicPropertyType<>("Camera.OrthogonalPlaneHeight", Float.class)

The value used for scaling the view area of a relative orthographic camera.

Initial value:
=
new DynamicPropertyType<>("Camera.ProjectionType", CameraEnums.ProjectionType.class)

Defines the camera type to either perspective or orthographic camera.

DynamicPropertyType<Float> ZFarProperty = new DynamicPropertyType<>("Camera.ZFar", Float.class)

The distance of the camera far clipping plane.

The camera shows only the objects that are closer than the value set in this property.

DynamicPropertyType<Float> ZNearProperty
Initial value:
=
new DynamicPropertyType<>("Camera.ZNear", Float.class)

The distance of the camera near clipping plane.

The camera shows only the objects that are farther away than the value set in this property.