org.cesiumjs.cs.core.geometry

Class GeometryPipeline

java.lang.Object

org.cesiumjs.cs.core.geometry.GeometryPipeline

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

Content pipeline functions for geometries.

Author:

Serge Silaev aka iSergio

Method Summary

Modifier and Type	Method and Description
static Geometry	compressVertices(Geometry geometry) Compresses and packs geometry normal attribute values to save memory.
static Geometry	computeNormal(Geometry geometry) Computes per-vertex normals for a geometry containing TRIANGLES by averaging the normals of all triangles incident to the vertex.
static Geometry	computeTangentAndBitangent(Geometry geometry) Computes per-vertex tangents and bitangents for a geometry containing TRIANGLES.
static Object	createAttributeLocations(Geometry geometry) Creates an object that maps attribute names to unique locations (indices) for matching vertex attributes and shader programs.
static Geometry	createLineSegmentsForVectors(Geometry geometry) Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry.
static Geometry	createLineSegmentsForVectors(Geometry geometry, String attributeName) Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry.
static Geometry	createLineSegmentsForVectors(Geometry geometry, String attributeName, double length) Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry.
static Geometry	encodeAttribute(Geometry geometry, String attributeName, String attributeHighName, String attributeLowName) Encodes floating-point geometry attribute values as two separate attributes to improve rendering precision.
static Geometry[]	fitToUnsignedShortIndices(Geometry geometry) Splits a geometry into multiple geometries, if necessary, to ensure that indices in the indices fit into unsigned shorts.
static Geometry	projectTo2D(String geometry, String attributeName, String attributeName3D, String attributeName2D) Projects a geometry's 3D position attribute to 2D, replacing the position attribute with separate position3D and position2D attributes.
static Geometry	projectTo2D(String geometry, String attributeName, String attributeName3D, String attributeName2D, MapProjection projection) Projects a geometry's 3D position attribute to 2D, replacing the position attribute with separate position3D and position2D attributes.
static Geometry	reorderForPostVertexCache(Geometry geometry) Reorders a geometry's indices to achieve better performance from the GPU's post vertex-shader cache by using the Tipsify algorithm.
static Geometry	reorderForPostVertexCache(Geometry geometry, int cacheCapacity) Reorders a geometry's indices to achieve better performance from the GPU's post vertex-shader cache by using the Tipsify algorithm.
static Geometry	reorderForPreVertexCache(Geometry geometry) Reorders a geometry's attributes and indices to achieve better performance from the GPU's pre-vertex-shader cache.
static Geometry	toWireframe(Geometry geometry) Converts a geometry's triangle indices to line indices.
static GeometryInstance	transformToWorldCoordinates(GeometryInstance instance) Transforms a geometry instance to world coordinates.

Methods inherited from class java.lang.Object

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

Method Detail

compressVertices

@JsMethod
public static Geometry compressVertices(Geometry geometry)

Compresses and packs geometry normal attribute values to save memory.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument, with its normals compressed and packed.

computeTangentAndBitangent

@JsMethod
public static Geometry computeTangentAndBitangent(Geometry geometry)

Computes per-vertex tangents and bitangents for a geometry containing TRIANGLES. The result is new tangent and bitangent attributes added to the geometry. This assumes a counter-clockwise winding order.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument with the computed tangent and bitangent attributes.

computeNormal

@JsMethod
public static Geometry computeNormal(Geometry geometry)

Computes per-vertex normals for a geometry containing TRIANGLES by averaging the normals of all triangles incident to the vertex. The result is a new normal attribute added to the geometry. This assumes a counter-clockwise winding order.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument with the computed normal attribute.

createAttributeLocations

@JsMethod
public static Object createAttributeLocations(Geometry geometry)

Creates an object that maps attribute names to unique locations (indices) for matching vertex attributes and shader programs.

Parameters:

geometry - The geometry, which is not modified, to create the object for.

Returns:

An object with attribute name / index pairs.

createLineSegmentsForVectors

@JsMethod
public static Geometry createLineSegmentsForVectors(Geometry geometry)

Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry. This is used to visualize vector attributes like normals, binormals, and tangents.

Parameters:

geometry - The Geometry instance with the attribute.

Returns:

A new Geometry instance with line segments for the vector.

createLineSegmentsForVectors

@JsMethod
public static Geometry createLineSegmentsForVectors(Geometry geometry,
                                                              String attributeName)

Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry. This is used to visualize vector attributes like normals, binormals, and tangents.

Parameters:

geometry - The Geometry instance with the attribute.

attributeName - The name of the attribute. Default: 'normal'.

Returns:

A new Geometry instance with line segments for the vector.

createLineSegmentsForVectors

@JsMethod
public static Geometry createLineSegmentsForVectors(Geometry geometry,
                                                              String attributeName,
                                                              double length)

Creates a new Geometry with LINES representing the provided attribute (attributeName) for the provided geometry. This is used to visualize vector attributes like normals, binormals, and tangents.

Parameters:

geometry - The Geometry instance with the attribute.

attributeName - The name of the attribute. Default: 'normal'.

length - The length of each line segment in meters. This can be negative to point the vector in the opposite direction. Default: 10000.0

Returns:

A new Geometry instance with line segments for the vector.

encodeAttribute

@JsMethod
public static Geometry encodeAttribute(Geometry geometry,
                                                 String attributeName,
                                                 String attributeHighName,
                                                 String attributeLowName)

Encodes floating-point geometry attribute values as two separate attributes to improve rendering precision. This is commonly used to create high-precision position vertex attributes.

Parameters:

geometry - The geometry to modify.

attributeName - The name of the attribute.

attributeHighName - The name of the attribute for the encoded high bits.

attributeLowName - The name of the attribute for the encoded low bits.

Returns:

The modified geometry argument, with its encoded attribute.

fitToUnsignedShortIndices

@JsMethod
public static Geometry[] fitToUnsignedShortIndices(Geometry geometry)

Splits a geometry into multiple geometries, if necessary, to ensure that indices in the indices fit into unsigned shorts. This is used to meet the WebGL requirements when unsigned int indices are not supported. If the geometry does not have any indices, this function has no effect.

Parameters:

geometry - The geometry to be split into multiple geometries.

Returns:

An array of geometries, each with indices that fit into unsigned shorts.

projectTo2D

@JsMethod
public static Geometry projectTo2D(String geometry,
                                             String attributeName,
                                             String attributeName3D,
                                             String attributeName2D)

Projects a geometry's 3D position attribute to 2D, replacing the position attribute with separate position3D and position2D attributes. If the geometry does not have a position, this function has no effect.

Parameters:

geometry - The geometry to modify.

attributeName - The name of the attribute.

attributeName3D - The name of the attribute in 3D.

attributeName2D - The name of the attribute in 2D.

Returns:

The modified geometry argument with position3D and position2D attributes.

projectTo2D

@JsMethod
public static Geometry projectTo2D(String geometry,
                                             String attributeName,
                                             String attributeName3D,
                                             String attributeName2D,
                                             MapProjection projection)

Projects a geometry's 3D position attribute to 2D, replacing the position attribute with separate position3D and position2D attributes. If the geometry does not have a position, this function has no effect.

Parameters:

geometry - The geometry to modify.

attributeName - The name of the attribute.

attributeName3D - The name of the attribute in 3D.

attributeName2D - The name of the attribute in 2D.

projection - The projection to use.

Returns:

The modified geometry argument with position3D and position2D attributes.

reorderForPostVertexCache

@JsMethod
public static Geometry reorderForPostVertexCache(Geometry geometry)

Reorders a geometry's indices to achieve better performance from the GPU's post vertex-shader cache by using the Tipsify algorithm. If the geometry primitiveType is not TRIANGLES or the geometry does not have an indices, this function has no effect.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument, with its indices reordered for the post-vertex-shader cache.

reorderForPostVertexCache

@JsMethod
public static Geometry reorderForPostVertexCache(Geometry geometry,
                                                           int cacheCapacity)

Reorders a geometry's indices to achieve better performance from the GPU's post vertex-shader cache by using the Tipsify algorithm. If the geometry primitiveType is not TRIANGLES or the geometry does not have an indices, this function has no effect.

Parameters:

geometry - The geometry to modify.

cacheCapacity - The number of vertices that can be held in the GPU's vertex cache. Default: 24.

Returns:

The modified geometry argument, with its indices reordered for the post-vertex-shader cache.

See Also:

Fast Triangle Reordering for Vertex Locality and Reduced Overdraw by Sander, Nehab, and Barczak

reorderForPreVertexCache

@JsMethod
public static Geometry reorderForPreVertexCache(Geometry geometry)

Reorders a geometry's attributes and indices to achieve better performance from the GPU's pre-vertex-shader cache.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument, with its attributes and indices reordered for the GPU's pre-vertex-shader cache.

See Also:

reorderForPostVertexCache(org.cesiumjs.cs.core.geometry.Geometry)

toWireframe

@JsMethod
public static Geometry toWireframe(Geometry geometry)

Converts a geometry's triangle indices to line indices. If the geometry has an indices and its primitiveType is TRIANGLES, TRIANGLE_STRIP, TRIANGLE_FAN, it is converted to LINES; otherwise, the geometry is not changed. This is commonly used to create a wireframe geometry for visual debugging.

Parameters:

geometry - The geometry to modify.

Returns:

The modified geometry argument, with its triangle indices converted to lines.

transformToWorldCoordinates

@JsMethod
public static GeometryInstance transformToWorldCoordinates(GeometryInstance instance)

Transforms a geometry instance to world coordinates. This changes the instance's modelMatrix to Matrix4.IDENTITY and transforms the following attributes if they are present: position, normal, binormal, and tangent.

Parameters:

instance - The geometry instance to modify.

Returns:

The modified instance argument, with its attributes transforms to world coordinates.