org.cesiumjs.cs.scene

Class Expression

java.lang.Object

org.cesiumjs.cs.scene.Expression

All Implemented Interfaces:

StyleExpression

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

An expression for a style applied to a Cesium3DTileset. Evaluates an expression defined using the Evaluates a conditions expression defined using the 3D Tiles Styling language.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
Expression() An expression for a style applied to a Cesium3DTileset
Expression(String expression) An expression for a style applied to a Cesium3DTileset
Expression(String expression, JsObject defines) An expression for a style applied to a Cesium3DTileset

Method Summary

Modifier and Type	Method and Description
Object	evaluate(Cesium3DTileFeature feature) Evaluates the result of an expression, optionally using the provided feature's properties.
Object	evaluate(Cesium3DTileFeature feature, Object result) Evaluates the result of an expression, optionally using the provided feature's properties.
Color	evaluateColor(Cesium3DTileFeature feature) Evaluates the result of a Color expression, optionally using the provided feature's properties.
Color	evaluateColor(Cesium3DTileFeature feature, Color result) Evaluates the result of a Color expression, optionally using the provided feature's properties.
String	expression() Gets the expression defined in the 3D Tiles Styling language.

Methods inherited from class java.lang.Object

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

Constructor Detail

Expression

@JsConstructor
public Expression()

An expression for a style applied to a Cesium3DTileset

Expression

@JsConstructor
public Expression(String expression)

An expression for a style applied to a Cesium3DTileset

Parameters:

expression - The expression defined using the 3D Tiles Styling language.

Expression

@JsConstructor
public Expression(String expression,
                                 JsObject defines)

An expression for a style applied to a Cesium3DTileset

Parameters:

expression - The expression defined using the 3D Tiles Styling language.

defines - Defines in the style.

Method Detail

expression

@JsProperty(name="expression")
public String expression()

Gets the expression defined in the 3D Tiles Styling language. Default: undefined

evaluate

@JsMethod
public Object evaluate(Cesium3DTileFeature feature)

Evaluates the result of an expression, optionally using the provided feature's properties. If the result of the expression in the 3D Tiles Styling language is of type Boolean, Number, or String, the corresponding JavaScript primitive type will be returned. If the result is a RegExp, a Javascript RegExp object will be returned. If the result is a Cartesian2, Cartesian3, or Cartesian4, a Cartesian2, Cartesian3, or Cartesian4 object will be returned. If the result argument is a Color, the Cartesian4 value is converted to a Color and then returned.

Parameters:

feature - The feature whose properties may be used as variables in the expression.

Returns:

The result of evaluating the expression.

evaluate

@JsMethod
public Object evaluate(Cesium3DTileFeature feature,
                                 Object result)

Evaluates the result of an expression, optionally using the provided feature's properties. If the result of the expression in the 3D Tiles Styling language is of type Boolean, Number, or String, the corresponding JavaScript primitive type will be returned. If the result is a RegExp, a Javascript RegExp object will be returned. If the result is a Cartesian2, Cartesian3, or Cartesian4, a Cartesian2, Cartesian3, or Cartesian4 object will be returned. If the result argument is a Color, the Cartesian4 value is converted to a Color and then returned.

Parameters:

feature - The feature whose properties may be used as variables in the expression.

result - The object onto which to store the result.

Returns:

The result of evaluating the expression.

evaluateColor

@JsMethod
public Color evaluateColor(Cesium3DTileFeature feature)

Evaluates the result of a Color expression, optionally using the provided feature's properties. This is equivalent to StyleExpression#evaluate but always returns a Color object.

Parameters:

feature - The feature whose properties may be used as variables in the expression.

Returns:

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

evaluateColor

@JsMethod
public Color evaluateColor(Cesium3DTileFeature feature,
                                     Color result)

Evaluates the result of a Color expression, optionally using the provided feature's properties. This is equivalent to StyleExpression#evaluate but always returns a Color object.

Parameters:

feature - The feature whose properties may be used as variables in the expression.

result - The object in which to store the result.

Returns:

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