Class ProjectedImageryFeature.Builder
- All Implemented Interfaces:
AutoCloseable
- Enclosing class:
ProjectedImageryFeature
Builder for creating a projected imagery Feature object.
Configure the mandatory id and location (and optionally rotation and fovs) on this builder, then call build to obtain the Feature. If a mandatory property is missing, a java.lang.IllegalStateException is thrown.
- Since:
- 2026.1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the projected imagery feature using the configured settings.voidclose()protected voidfinalize()fovs(double fovX, double fovY) Configures the horizontal and vertical field of view of the projected imagery feature being built.id(long id) Configures the ID of the projected imagery feature being built.Configures the location of the projected imagery feature being built.projectionId(String projectionId) Configures the projection ID of the projected imagery feature being built.rotation(double yaw, double pitch, double roll) Configures the rotation of the projected imagery feature being built.
-
Constructor Details
-
Builder
Copy constructor.- Parameters:
other- the builder to copy.
-
-
Method Details
-
finalize
protected void finalize() -
close
public void close()- Specified by:
closein interfaceAutoCloseable
-
build
Builds the projected imagery feature using the configured settings.After this method is invoked once, this builder can no longer be used.
- Returns:
- the feature.
- Throws:
IllegalStateException- if not all mandatory parameters are set.
-
id
Configures the ID of the projected imagery feature being built.A feature ID should be unique across a model.
Calling this function is mandatory.
- Parameters:
id- the ID.- Returns:
- this builder.
-
location
Configures the location of the projected imagery feature being built.This is the position of the virtual camera in the model's coordinate reference.
Calling this function is mandatory.
- Parameters:
location- the camera location.- Returns:
- this builder.
-
fovs
Configures the horizontal and vertical field of view of the projected imagery feature being built.Both angles are expressed in degrees.
Calling this function is optional. A field of view describes a perspective frustum, so it applies to pinhole projectors such as a video camera. Panorama positions typically have no frustum and leave it unset.
- Parameters:
fovX- the horizontal field of view, in degrees.fovY- the vertical field of view, in degrees.- Returns:
- this builder.
-
rotation
Configures the rotation of the projected imagery feature being built.The rotation is given as yaw (clockwise from the north), pitch and roll, all expressed in degrees.
Calling this function is optional. The default rotation is
(0, 0, 0).- Parameters:
yaw- the yaw, in degrees.pitch- the pitch, in degrees.roll- the roll, in degrees.- Returns:
- this builder.
-
projectionId
Configures the projection ID of the projected imagery feature being built.This is the string ID of the projection the feature represents (
ProjectedImagery#getId), stored as a property that is distinct from the feature's numeric ID. Calling this function is optional.- Parameters:
projectionId- the projection ID.- Returns:
- this builder.
-