import ColorGeometryInstanceAttribute from "../Core/ColorGeometryInstanceAttribute.js";
import defaultValue from "../Core/defaultValue.js";
import defined from "../Core/defined.js";
import DeveloperError from "../Core/DeveloperError.js";
import GeometryInstance from "../Core/GeometryInstance.js";
import GeometryPipeline from "../Core/GeometryPipeline.js";
import Matrix4 from "../Core/Matrix4.js";
import PerInstanceColorAppearance from "./PerInstanceColorAppearance.js";
import Primitive from "./Primitive.js";
/**
* Creates a {@link Primitive} to visualize well-known vector vertex attributes:
* normal
, tangent
, and bitangent
. Normal
* is red; tangent is green; and bitangent is blue. If an attribute is not
* present, it is not drawn.
*
* @function
*
* @param {object} options Object with the following properties:
* @param {Geometry} options.geometry The Geometry
instance with the attribute.
* @param {number} [options.length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction.
* @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates.
* @returns {Primitive} A new Primitive
instance with geometry for the vectors.
*
* @example
* scene.primitives.add(Cesium.createTangentSpaceDebugPrimitive({
* geometry : instance.geometry,
* length : 100000.0,
* modelMatrix : instance.modelMatrix
* }));
*/
function createTangentSpaceDebugPrimitive(options) {
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
const instances = [];
let geometry = options.geometry;
//>>includeStart('debug', pragmas.debug);
if (!defined(geometry)) {
throw new DeveloperError("options.geometry is required.");
}
//>>includeEnd('debug');
if (!defined(geometry.attributes) || !defined(geometry.primitiveType)) {
// to create the debug lines, we need the computed attributes.
// compute them if they are undefined.
geometry = geometry.constructor.createGeometry(geometry);
}
const attributes = geometry.attributes;
const modelMatrix = Matrix4.clone(
defaultValue(options.modelMatrix, Matrix4.IDENTITY)
);
const length = defaultValue(options.length, 10000.0);
if (defined(attributes.normal)) {
instances.push(
new GeometryInstance({
geometry: GeometryPipeline.createLineSegmentsForVectors(
geometry,
"normal",
length
),
attributes: {
color: new ColorGeometryInstanceAttribute(1.0, 0.0, 0.0, 1.0),
},
modelMatrix: modelMatrix,
})
);
}
if (defined(attributes.tangent)) {
instances.push(
new GeometryInstance({
geometry: GeometryPipeline.createLineSegmentsForVectors(
geometry,
"tangent",
length
),
attributes: {
color: new ColorGeometryInstanceAttribute(0.0, 1.0, 0.0, 1.0),
},
modelMatrix: modelMatrix,
})
);
}
if (defined(attributes.bitangent)) {
instances.push(
new GeometryInstance({
geometry: GeometryPipeline.createLineSegmentsForVectors(
geometry,
"bitangent",
length
),
attributes: {
color: new ColorGeometryInstanceAttribute(0.0, 0.0, 1.0, 1.0),
},
modelMatrix: modelMatrix,
})
);
}
if (instances.length > 0) {
return new Primitive({
asynchronous: false,
geometryInstances: instances,
appearance: new PerInstanceColorAppearance({
flat: true,
translucent: false,
}),
});
}
return undefined;
}
export default createTangentSpaceDebugPrimitive;