org.cesiumjs.cs.datasources.graphics

Class BoxGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.BoxGraphics

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Property	dimensions Gets or sets Cartesian3 Property property specifying the length, width, and height of the box.
Property	distanceDisplayCondition Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this box will be displayed.
Property	fill Gets or sets the boolean Property specifying whether the box is filled with the provided material.
Number	heightReference Gets or sets the Property specifying the HeightReference.
MaterialProperty	material Gets or sets the material used to fill the box.
Property	outline Gets or sets the Property specifying whether the box is outlined.
Property	outlineColor Gets or sets the Property specifying the Color of the outline.
Property	outlineWidth Gets or sets the numeric Property specifying the width of the outline.
Property	shadows Get or sets the enum Property specifying whether the box casts or receives shadows from each light source.
Property	show Gets or sets the boolean Property specifying the visibility of the box.

Constructor Summary

Constructors

Constructor and Description
BoxGraphics() Describes a box.
BoxGraphics(BoxGraphicsOptions options) Describes a box.

Method Summary

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

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

Field Detail

dimensions

@JsProperty
public Property dimensions

Gets or sets Cartesian3 Property property specifying the length, width, and height of the box.

distanceDisplayCondition

@JsProperty
public Property distanceDisplayCondition

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this box will be displayed.

fill

@JsProperty
public Property fill

Gets or sets the boolean Property specifying whether the box is filled with the provided material. Default: true

heightReference

@JsProperty
public Number heightReference

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

material

@JsProperty
public MaterialProperty material

Gets or sets the material used to fill the box. Default: Color.WHITE()

outline

@JsProperty
public Property outline

Gets or sets the Property specifying whether the box is outlined. Default: false

outlineColor

@JsProperty
public Property outlineColor

Gets or sets the Property specifying the Color of the outline. Default: Color.BLACK()

outlineWidth

@JsProperty
public Property outlineWidth

Gets or sets the numeric Property specifying the width of the outline. Default: 1.0

shadows

@JsProperty
public Property shadows

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

show

@JsProperty
public Property show

Gets or sets the boolean Property specifying the visibility of the box. Default: true

Constructor Detail

BoxGraphics

@JsConstructor
public BoxGraphics()

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

BoxGraphics

@JsConstructor
public BoxGraphics(BoxGraphicsOptions options)

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

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

public BoxGraphics clone()

Duplicates this instance.

Overrides:

clone in class Object

Returns:

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

clone

public BoxGraphics clone(BoxGraphics 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

public void merge(BoxGraphics 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.