org.cesiumjs.cs.core

Class CullingVolume

java.lang.Object

org.cesiumjs.cs.core.CullingVolume

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

The culling volume defined by planes.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Cartesian4[]	planes Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin.

Constructor Summary

Constructors

Constructor and Description
CullingVolume() The culling volume defined by planes.
CullingVolume(Cartesian4[] planes) The culling volume defined by planes.

Method Summary

Modifier and Type	Method and Description
int	computeVisibility(Object boundingVolume) Determines whether a bounding volume intersects the culling volume.
static CullingVolume	fromBoundingSphere(BoundingSphere boundingSphere) Constructs a culling volume from a bounding sphere.
static CullingVolume	fromBoundingSphere(BoundingSphere boundingSphere, CullingVolume result) Constructs a culling volume from a bounding sphere.

Methods inherited from class java.lang.Object

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

Field Detail

planes

@JsProperty
public Cartesian4[] planes

Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin. Default: []

Constructor Detail

CullingVolume

@JsConstructor
public CullingVolume()

The culling volume defined by planes.

CullingVolume

@JsConstructor
public CullingVolume(Cartesian4[] planes)

The culling volume defined by planes.

Parameters:

planes - An array of clipping planes.

Method Detail

fromBoundingSphere

public static CullingVolume fromBoundingSphere(BoundingSphere boundingSphere)

Constructs a culling volume from a bounding sphere. Creates six planes that create a box containing the sphere. The planes are aligned to the x, y, and z axes in world coordinates.

Parameters:

boundingSphere - The bounding sphere used to create the culling volume.

Returns:

The culling volume created from the bounding sphere.

fromBoundingSphere

public static CullingVolume fromBoundingSphere(BoundingSphere boundingSphere,
                                               CullingVolume result)

Constructs a culling volume from a bounding sphere. Creates six planes that create a box containing the sphere. The planes are aligned to the x, y, and z axes in world coordinates.

Parameters:

boundingSphere - The bounding sphere used to create the culling volume.

result - The object onto which to store the result.

Returns:

The culling volume created from the bounding sphere.

computeVisibility

public int computeVisibility(Object boundingVolume)

Determines whether a bounding volume intersects the culling volume.

Parameters:

boundingVolume - The bounding volume whose intersection with the culling volume is to be tested.

Returns:

Intersect.OUTSIDE(), Intersect.INTERSECTING(), or Intersect.INSIDE().

See Also:

Intersect