org.cesiumjs.cs.core

Class VertexFormat

java.lang.Object

org.cesiumjs.cs.core.VertexFormat

All Implemented Interfaces:

Packable

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bitangent When true, the vertex has a bitangent attribute (normalized), which is used for tangent-space effects like bump mapping. 32-bit floating-point. 3 components per attribute.
boolean	color When true, the vertex has an RGB color attribute. 8-bit unsigned byte. 3 components per attribute.
boolean	normal When true, the vertex has a normal attribute (normalized), which is commonly used for lighting. 32-bit floating-point. 3 components per attribute.
boolean	position When true, the vertex has a 3D position attribute. 64-bit floating-point (for precision). 3 components per attribute.
boolean	st When true, the vertex has a 2D texture coordinate attribute. 32-bit floating-point. 2 components per attribute Default: false
boolean	tangent When true, the vertex has a tangent attribute (normalized), which is used for tangent-space effects like bump mapping. 32-bit floating-point. 3 components per attribute.

Constructor Summary

Constructors

Constructor and Description
VertexFormat() A vertex format defines what attributes make up a vertex.
VertexFormat(VertexFormatOptions options) A vertex format defines what attributes make up a vertex.

Method Summary

Modifier and Type	Method and Description
static VertexFormat	clone(VertexFormat cartesian) Duplicates a VertexFormat instance.
static VertexFormat	clone(VertexFormat cartesian, VertexFormat result) Duplicates a VertexFormat instance.
static VertexFormat	DEFAULT() An immutable vertex format with position, normal, and st attributes.
static double[]	pack(VertexFormat value, double[] array) Stores the provided instance into the provided array.
static double[]	pack(VertexFormat value, double[] array, int startingIndex) Stores the provided instance into the provided array.
static int	packedLength() The number of elements used to pack the object into an array.
static VertexFormat	POSITION_AND_COLOR() An immutable vertex format with position and color attributes.
static VertexFormat	POSITION_AND_NORMAL() An immutable vertex format with position and normal attributes.
static VertexFormat	POSITION_AND_ST() An immutable vertex format with position and st attributes.
static VertexFormat	POSITION_NORMAL_AND_ST() An immutable vertex format with position, normal, and st attributes.
static VertexFormat	POSITION_ONLY() An immutable vertex format with only a position attribute.
static VertexFormat	unpack(double[] array) Retrieves an instance from a packed array.
static VertexFormat	unpack(double[] array, int startingIndex) Retrieves an instance from a packed array.
static VertexFormat	unpack(double[] array, int startingIndex, VertexFormat result) Retrieves an instance from a packed array.

Methods inherited from class java.lang.Object

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

Field Detail

bitangent

@JsProperty
public boolean bitangent

When true, the vertex has a bitangent attribute (normalized), which is used for tangent-space effects like bump mapping. 32-bit floating-point. 3 components per attribute. Default: false

color

@JsProperty
public boolean color

When true, the vertex has an RGB color attribute. 8-bit unsigned byte. 3 components per attribute. Default: false

normal

@JsProperty
public boolean normal

When true, the vertex has a normal attribute (normalized), which is commonly used for lighting. 32-bit floating-point. 3 components per attribute. Default: false

position

@JsProperty
public boolean position

When true, the vertex has a 3D position attribute. 64-bit floating-point (for precision). 3 components per attribute. Default: false

st

@JsProperty
public boolean st

When true, the vertex has a 2D texture coordinate attribute. 32-bit floating-point. 2 components per attribute Default: false

tangent

@JsProperty
public boolean tangent

When true, the vertex has a tangent attribute (normalized), which is used for tangent-space effects like bump mapping. 32-bit floating-point. 3 components per attribute. Default: false

Constructor Detail

VertexFormat

@JsConstructor
public VertexFormat()

A vertex format defines what attributes make up a vertex. A VertexFormat can be provided to a Geometry to request that certain properties be computed, e.g., just position, position and normal, etc.

VertexFormat

@JsConstructor
public VertexFormat(VertexFormatOptions options)

A vertex format defines what attributes make up a vertex. A VertexFormat can be provided to a Geometry to request that certain properties be computed, e.g., just position, position and normal, etc.

Parameters:

options - Options

Method Detail

DEFAULT

@JsProperty(name="DEFAULT")
public static VertexFormat DEFAULT()

An immutable vertex format with position, normal, and st attributes. This is compatible with most appearances and materials; however normal and st attributes are not always required. When this is known in advance, another VertexFormat should be used.

See Also:

position, normal

packedLength

@JsProperty(name="packedLength")
public static int packedLength()

The number of elements used to pack the object into an array.

POSITION_AND_COLOR

@JsProperty(name="POSITION_AND_COLOR")
public static VertexFormat POSITION_AND_COLOR()

An immutable vertex format with position and color attributes.

See Also:

position, color

POSITION_AND_NORMAL

@JsProperty(name="POSITION_AND_NORMAL")
public static VertexFormat POSITION_AND_NORMAL()

An immutable vertex format with position and normal attributes. This is compatible with per-instance color appearances like PerInstanceColorAppearance.

See Also:

position, normal

POSITION_AND_ST

@JsProperty(name="POSITION_AND_ST")
public static VertexFormat POSITION_AND_ST()

An immutable vertex format with position and st attributes. This is compatible with EllipsoidSurfaceAppearance.

See Also:

position, st

POSITION_NORMAL_AND_ST

@JsProperty(name="POSITION_NORMAL_AND_ST")
public static VertexFormat POSITION_NORMAL_AND_ST()

An immutable vertex format with position, normal, and st attributes. This is compatible with MaterialAppearance when MaterialAppearance#materialSupport is TEXTURED/code>.

See Also:

position, normal, st

POSITION_ONLY

@JsProperty(name="POSITION_ONLY")
public static VertexFormat POSITION_ONLY()

An immutable vertex format with only a position attribute.

See Also:

position

clone

@JsMethod
public static VertexFormat clone(VertexFormat cartesian)

Duplicates a VertexFormat instance.

Parameters:

cartesian - The vertex format to duplicate.

Returns:

The modified result parameter or a new VertexFormat instance if one was not provided. (Returns undefined if vertexFormat is undefined)

clone

@JsMethod
public static VertexFormat clone(VertexFormat cartesian,
                                           VertexFormat result)

Duplicates a VertexFormat instance.

Parameters:

cartesian - The vertex format to duplicate.

result - The object onto which to store the result.

Returns:

The modified result parameter or a new VertexFormat instance if one was not provided. (Returns undefined if vertexFormat is undefined)

pack

@JsMethod
public static double[] pack(VertexFormat value,
                                      double[] array)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

Returns:

The array that was packed into

pack

@JsMethod
public static double[] pack(VertexFormat value,
                                      double[] array,
                                      int startingIndex)

Stores the provided instance into the provided array.

Parameters:

value - The value to pack.

array - The array to pack into.

startingIndex - The index into the array at which to start packing the elements.

Returns:

The array that was packed into

unpack

@JsMethod
public static VertexFormat unpack(double[] array)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

Returns:

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

unpack

@JsMethod
public static VertexFormat unpack(double[] array,
                                            int startingIndex)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked.

Returns:

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

unpack

@JsMethod
public static VertexFormat unpack(double[] array,
                                            int startingIndex,
                                            VertexFormat result)

Retrieves an instance from a packed array.

Parameters:

array - The packed array.

startingIndex - The starting index of the element to be unpacked.

result - The object into which to store the result.

Returns:

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