Class ProjectedImageryStyle
- All Implemented Interfaces:
AutoCloseable
Construction is done through the Builder.
- Since:
- 2026.1
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionCreates a new builder initialized with all the properties of this style.voidclose()booleanprotected voidfinalize()doubleReturns the opacity of the base layer used when projecting on the closest surface.doubleReturns the maximum projection distance, in meters.doubleReturns the opacity of the projected imagery.doubleReturns the additional pitch offset, in degrees, applied on top of each projection's own orientation.Returns theProjectedImageryTargetthat determines onto which surfaces the imagery is projected.doubleReturns the additional roll offset, in degrees, applied on top of each projection's own orientation.doubleReturns the opacity of the sky, the part of the projection that does not hit any surface.doubleReturns the additional yaw offset, in degrees, applied on top of each projection's own orientation.inthashCode()Creates a new builder with the default values.
-
Method Details
-
finalize
protected void finalize() -
close
public void close()- Specified by:
closein interfaceAutoCloseable
-
newBuilder
Creates a new builder with the default values.- Returns:
- the new builder.
-
asBuilder
Creates a new builder initialized with all the properties of this style.- Returns:
- the new builder.
-
getOpacity
public double getOpacity()Returns the opacity of the projected imagery.The opacity is a value in the range
[0, 1]. A value of 1 (the default) is fully opaque, a value of 0 is fully transparent.- Returns:
- the opacity of the projected imagery.
-
getSkyOpacity
public double getSkyOpacity()Returns the opacity of the sky, the part of the projection that does not hit any surface.The value is in the range
[0, 1]. The default is 1 (the sky is fully opaque).- Returns:
- the opacity of the sky, the part of the projection that does not hit any surface.
-
getProjectionTarget
Returns theProjectedImageryTargetthat determines onto which surfaces the imagery is projected.The default value is
ProjectedImageryTarget#AllSurfaces.- Returns:
- the
ProjectedImageryTargetthat determines onto which surfaces the imagery is projected.
-
getBaseOpacity
public double getBaseOpacity()Returns the opacity of the base layer used when projecting on the closest surface.The value is in the range
[0, 1]. The default is 0, which disables the base layer. This setting only has an effect when theProjectedImageryTargetisProjectedImageryTarget#ClosestSurface.- Returns:
- the opacity of the base layer used when projecting on the closest surface.
-
getYawOffset
public double getYawOffset()Returns the additional yaw offset, in degrees, applied on top of each projection's own orientation.The default is 0.
- Returns:
- the additional yaw offset, in degrees, applied on top of each projection's own orientation.
-
getPitchOffset
public double getPitchOffset()Returns the additional pitch offset, in degrees, applied on top of each projection's own orientation.The default is 0.
- Returns:
- the additional pitch offset, in degrees, applied on top of each projection's own orientation.
-
getRollOffset
public double getRollOffset()Returns the additional roll offset, in degrees, applied on top of each projection's own orientation.The default is 0.
- Returns:
- the additional roll offset, in degrees, applied on top of each projection's own orientation.
-
getMaxRange
public double getMaxRange()Returns the maximum projection distance, in meters.A value of 0 (the default) applies a target-dependent default range: 100 km when the projection target is
ProjectedImageryTarget#AllSurfacesand 1 km when it isProjectedImageryTarget#ClosestSurface.- Returns:
- the maximum projection distance, in meters.
-
hashCode
public int hashCode() -
equals
-