org.cesiumjs.cs.datasources.graphics

Class PlaneGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.PlaneGraphics

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

Describes a plane. The center position and orientation are determined by the containing Entity.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Property	dimensions A Cartesian2 Property specifying the width and height of the plane.
Property	distanceDisplayCondition A Property specifying at what distance from the camera that this plane will be displayed.
Property	fill A boolean Property specifying whether the plane is filled with the provided material.
MaterialProperty	material A Property specifying the material used to fill the plane.
Property	outline A boolean Property specifying whether the plane is outlined.
Property	outlineColor A Property specifying the Color of the outline.
Property	outlineWidth A numeric Property specifying the width of the outline.
Property	plane A Plane Property specifying the normal and distance for the plane.
Property	shadows An enum Property specifying whether the plane casts or receives shadows from each light source.
Property	show A boolean Property specifying the visibility of the plane.

Constructor Summary

Constructors

Constructor and Description
PlaneGraphics() Describes a plane.
PlaneGraphics(PlaneGraphicsOptions options) Describes a plane.

Method Summary

Modifier and Type	Method and Description
PlaneGraphics	clone(PlaneGraphics result) Duplicates this instance.
Event	definitionChanged() Gets the event that is raised whenever a property or sub-property is changed or modified.
void	merge(PlaneGraphics 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

plane

@JsProperty
public Property plane

A Plane Property specifying the normal and distance for the plane.

dimensions

@JsProperty
public Property dimensions

A Cartesian2 Property specifying the width and height of the plane.

show

@JsProperty
public Property show

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

fill

@JsProperty
public Property fill

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

material

@JsProperty
public MaterialProperty material

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

outline

@JsProperty
public Property outline

A boolean Property specifying whether the plane 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

shadows

@JsProperty
public Property shadows

An enum Property specifying whether the plane 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 plane will be displayed.

Constructor Detail

PlaneGraphics

@JsConstructor
public PlaneGraphics()

Describes a plane. The center position and orientation are determined by the containing Entity.

PlaneGraphics

@JsConstructor
public PlaneGraphics(PlaneGraphicsOptions options)

Describes a plane. The center position and orientation are determined by the containing Entity.

Parameters:

options - object PlaneGraphicsOptions.

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 PlaneGraphics clone(PlaneGraphics 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(PlaneGraphics 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.