org.cesiumjs.cs.datasources.graphics

Class CorridorGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.CorridorGraphics

@JsType(isNative=true,
        namespace="Cesium",
        name="CorridorGraphics")
public class CorridorGraphics
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	classificationType Gets or sets the ClassificationType Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground.
Property	cornerType A CornerType Property specifying the style of the corners.
Property	distanceDisplayCondition A Property specifying at what distance from the camera that this corridor will be displayed.
Property	extrudedHeight A numeric Property specifying the altitude of the corridor's extruded face relative to the ellipsoid surface.
Property	extrudedHeightReference Gets or sets the Property specifying the extruded HeightReference.
Property	fill A boolean Property specifying whether the corridor is filled with the provided material.
Property	granularity A numeric Property specifying the distance between each latitude and longitude.
Property	height A numeric Property specifying the altitude of the corridor relative to the ellipsoid surface.
Property	heightReference Gets or sets the Property specifying the HeightReference.
Property	material A Property specifying the material used to fill the corridor.
Property	outline A boolean Property specifying whether the corridor is outlined.
Property	outlineColor A Property specifying the Color of the outline.
Property	outlineWidth A numeric Property specifying the width of the outline.
Property	positions A Property specifying the array of Cartesian3 positions that define the centerline of the corridor.
Property	shadows An enum Property specifying whether the corridor casts or receives shadows from each light source.
Property	show A boolean Property specifying the visibility of the corridor.
Property	width A numeric Property specifying the distance between the edges of the corridor.
ConstantProperty<Integer>	zIndex A Property specifying the zIndex of the corridor, used for ordering.

Constructor Summary

Constructors

Constructor and Description
CorridorGraphics() Describes a corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe.
CorridorGraphics(CorridorGraphicsOptions options) Describes a corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe.

Method Summary

Modifier and Type	Method and Description
CorridorGraphics	clone(CorridorGraphics result) Duplicates this instance.
Event	definitionChanged() Gets the event that is raised whenever a property or sub-property is changed or modified.
void	merge(CorridorGraphics source) Assigns each unassigned property on this object to the value of the same property on the provided source object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classificationType

@JsProperty
public Number classificationType

Gets or sets the ClassificationType Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground. Default: ClassificationType.TERRAIN().

positions

@JsProperty
public Property positions

A Property specifying the array of Cartesian3 positions that define the centerline of the corridor.

width

@JsProperty
public Property width

A numeric Property specifying the distance between the edges of the corridor.

cornerType

@JsProperty
public Property cornerType

A CornerType Property specifying the style of the corners. Default: CornerType#ROUNDED

height

@JsProperty
public Property height

A numeric Property specifying the altitude of the corridor relative to the ellipsoid surface. Default: 0

heightReference

@JsProperty
public Property heightReference

Gets or sets the Property specifying the HeightReference. Default: HeightReference.NONE()

extrudedHeight

@JsProperty
public Property extrudedHeight

A numeric Property specifying the altitude of the corridor's extruded face relative to the ellipsoid surface.

extrudedHeightReference

@JsProperty
public Property extrudedHeightReference

Gets or sets the Property specifying the extruded HeightReference. Default: HeightReference.NONE()

show

@JsProperty
public Property show

A boolean Property specifying the visibility of the corridor. Default: true

fill

@JsProperty
public Property fill

A boolean Property specifying whether the corridor is filled with the provided material. Default: true

material

@JsProperty
public Property material

A Property specifying the material used to fill the corridor. Default: Color.WHITE()

outline

@JsProperty
public Property outline

A boolean Property specifying whether the corridor is outlined. Default: false

outlineColor

@JsProperty
public Property outlineColor

A Property specifying the Color of the outline. Default: Color.BLACK()

outlineWidth

@JsProperty
public Property outlineWidth

A numeric Property specifying the width of the outline. Default: 1.0

granularity

@JsProperty
public Property granularity

A numeric Property specifying the distance between each latitude and longitude. Default: Math.RADIANS_PER_DEGREE()

shadows

@JsProperty
public Property shadows

An enum Property specifying whether the corridor casts or receives shadows from each light source. Default: ShadowMode.DISABLED()

distanceDisplayCondition

@JsProperty
public Property distanceDisplayCondition

A Property specifying at what distance from the camera that this corridor will be displayed.

zIndex

@JsProperty
public ConstantProperty<Integer> zIndex

A Property specifying the zIndex of the corridor, used for ordering. Only has an effect if height and extrudedHeight are undefined, and if the corridor is static. Default: 0

Constructor Detail

CorridorGraphics

@JsConstructor
public CorridorGraphics()

Describes a corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe. It can be placed on the surface or at altitude and can optionally be extruded into a volume.

CorridorGraphics

@JsConstructor
public CorridorGraphics(CorridorGraphicsOptions options)

Describes a corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe. It can be placed on the surface or at altitude and can optionally be extruded into a volume.

Parameters:

options - Options

Method Detail

definitionChanged

@JsProperty(name="definitionChanged")
public Event definitionChanged()

Gets the event that is raised whenever a property or sub-property is changed or modified.

clone

@JsMethod
public CorridorGraphics clone(@JsOptional
                                        CorridorGraphics result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new instance if one was not provided.

merge

@JsMethod
public void merge(CorridorGraphics source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Parameters:

source - The object to be merged into this object.