org.cesiumjs.cs.scene

Class PointPrimitive

java.lang.Object

org.cesiumjs.cs.scene.PointPrimitive

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Color	color Gets or sets the inner color of the point.
double	disableDepthTestDistance Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
DistanceDisplayCondition	distanceDisplayCondition Gets or sets the condition specifying at what distance from the camera that this point will be displayed.
Object	id Gets or sets the user-defined object returned when the point is picked.
Color	outlineColor Gets or sets the outline color of the point.
double	outlineWidth Gets or sets the outline width in pixels.
int	pixelSize Gets or sets the inner size of the point in pixels.
Cartesian3	position Gets or sets the Cartesian position of this point.
NearFarScalar	scaleByDistance Gets or sets near and far scaling properties of a point based on the point's distance from the camera.
boolean	show Determines if this point will be shown.
NearFarScalar	translucencyByDistance Gets or sets near and far translucency properties of a point based on the point's distance from the camera.

Constructor Summary

Constructors

Constructor and Description
PointPrimitive() A graphical point positioned in the 3D scene, that is created and rendered using a PointPrimitiveCollection.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

color

@JsProperty
public Color color

Gets or sets the inner color of the point. The red, green, blue, and alpha values are indicated by value's red, green, blue, and alpha properties as shown in Example 1. These components range from 0.0 (no intensity) to 1.0 (full intensity).

disableDepthTestDistance

@JsProperty
public double disableDepthTestDistance

Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain. When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied. Default: 0.0

distanceDisplayCondition

@JsProperty
public DistanceDisplayCondition distanceDisplayCondition

Gets or sets the condition specifying at what distance from the camera that this point will be displayed. Default: undefined

id

@JsProperty
public Object id

Gets or sets the user-defined object returned when the point is picked.

outlineColor

@JsProperty
public Color outlineColor

Gets or sets the outline color of the point.

outlineWidth

@JsProperty
public double outlineWidth

Gets or sets the outline width in pixels. This width adds to pixelSize, increasing the total size of the point.

pixelSize

@JsProperty
public int pixelSize

Gets or sets the inner size of the point in pixels.

position

@JsProperty
public Cartesian3 position

Gets or sets the Cartesian position of this point.

scaleByDistance

@JsProperty
public NearFarScalar scaleByDistance

Gets or sets near and far scaling properties of a point based on the point's distance from the camera. A point's scale will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the upper and lower bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the point's scale remains clamped to the nearest bound. This scale multiplies the pixelSize and outlineWidth to affect the total size of the point. If undefined, scaleByDistance will be disabled.

show

@JsProperty
public boolean show

Determines if this point will be shown. Use this to hide or show a point, instead of removing it and re-adding it to the collection.

translucencyByDistance

@JsProperty
public NearFarScalar translucencyByDistance

Gets or sets near and far translucency properties of a point based on the point's distance from the camera. A point's translucency will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the upper and lower bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the point's translucency remains clamped to the nearest bound. If undefined, translucencyByDistance will be disabled.

Constructor Detail

PointPrimitive

@JsConstructor
public PointPrimitive()

A graphical point positioned in the 3D scene, that is created and rendered using a PointPrimitiveCollection. A point is created and its initial properties are set by calling PointPrimitiveCollection#add. Performance: Reading a property, e.g., PointPrimitive#show, is constant time. Assigning to a property is constant time but results in CPU to GPU traffic when PointPrimitiveCollection#update is called. The per-pointPrimitive traffic is the same regardless of how many properties were updated. If most pointPrimitives in a collection need to be updated, it may be more efficient to clear the collection with PointPrimitiveCollection#removeAll and add new pointPrimitives instead of modifying each one.

See Also:

PointPrimitiveCollection, PointPrimitiveCollection.add(org.cesiumjs.cs.scene.options.PointPrimitiveOptions)