MEMBERS

attributeDuplicateThresholds :object

IncisorAPI.js, line 3821

Contains a key for each attribute added to this GeometryEditor. The value at each key is the threshold used to determine if an attribute value should be considered to match another value in the same attribute Array. When a new vertex is added to the GeometryAccesor, its attribute values are compared to the existing vertices, by checking if the difference between the values is lower than this threshold.
If all attributes are considered to match, the existing vertex is re-used as an optimization. A threshold of 0 on any attribute will ensure that no vertices are ever considered to match each other, effectively disabling this optimization.

attributes :object

IncisorAPI.js, line 3804

Contains a key for each attribute added to this GeometryEditor. The value at each key is an Array of numbers containing the attribute data.

connectedGeometry :Geometry

IncisorAPI.js, line 3827

The Geometry that this GeometryEditor is connected to.

indices :Array.<Array.<number>>

IncisorAPI.js, line 3811

Each element in this Array corresponds to the elements in the materials Array of the Graphic that will use the resulting Geometry. Each element contains an Array of numbers containing the index data.

inheritedTypes :object

IncisorAPI.js, line 3797

Dictionary object listing all of the types this object is compatible with.

type :string

IncisorAPI.js, line 3791

Type identifier.

METHODS

addAttribute(name, type, size)

IncisorAPI.js, line 3870

Adds a new attribute.
If an attribute aleady exists with this name, the attribute is re-initialized and will be empty.

Parameters:

Name	Type	Attributes	Default	Description
name	string			The name of the attribute.
type	string			The type of number that should be used to store this attribute.
size	number			Specifies the number of components on this attribute. Must be 1, 2, 3, or 4.

addTriangle(vertex0, vertex1, vertex2, materialIndex)

IncisorAPI.js, line 3861

Adds a triangle that will use the Material at 'materialIndex' of the Graphic that will use the resulting Geometry.

Parameters:

Name	Type	Attributes	Default	Description
vertex0	object			Each key in this Object should be the name of an attribute in this GeometryEditor. The value should be a number, Vector2, Vector3, or Vector4 containing the value of the attribute at this vertex. Duplicate vertices will be automatically handled according to the values in attributeDuplicateThresholds.
vertex1	object			Each key in this Object should be the name of an attribute in this GeometryEditor. The value should be a number, Vector2, Vector3, or Vector4 containing the value of the attribute at this vertex. Duplicate vertices will be automatically handled according to the values in attributeDuplicateThresholds.
vertex2	object			Each key in this Object should be the name of an attribute in this GeometryEditor. The value should be a number, Vector2, Vector3, or Vector4 containing the value of the attribute at this vertex. Duplicate vertices will be automatically handled according to the values in attributeDuplicateThresholds.
materialIndex	number			The index into the materials Array of the Graphic that will use the resulting Geometry. Defaults to 0.

addVertex(vertex) returns {number}

IncisorAPI.js, line 3852

Adds a vertex that may be referenced by the indices.
The vertex's position in the attribute arrays is returned, and is the value that should be used by the indices to refer to this vertex. Note that the length of the attributes may not increase after this call completes if the vertex was found to be a duplicate of an existing vertex. In this scenario, the index of the existing vertex will be returned.

Parameters:

Name	Type	Attributes	Default	Description
vertex	object			Each key in this Object should be the name of an attribute in this GeometryEditor. The value should be a number, Vector2, Vector3, or Vector4 containing the value of the attribute at this vertex. The type of the value must correspond to the 'size' specified in 'addAttribute'. Duplicate vertices will be automatically handled according to the values in attributeDuplicateThresholds.

Returns:

number

commitChanges()

IncisorAPI.js, line 3919

Applies the changes performed by this GeometryEditor to the connectect Geometry. To optimize performance, this should be called once after all changes have been performed, as this function can have a performance impact.

convertGeometryToGrid(horizontalSegments, verticalSegments)

IncisorAPI.js, line 3884

Converts the connected Geometry to a grid of triangles oriented on the XY plane. Attribute values at each new point will be interpoloted linearly across the grid, using the attribute values at the minimum and maximum vertices of the original geometry.

Parameters:

Name	Type	Attributes	Default	Description
horizontalSegments	number			The number of horizontal segments of the grid.
verticalSegments	number			The number of vertical segments of the grid.

async copyGeometry(geometry, callbackOwner (opt), callbackName (opt), callbackArgs (opt))

IncisorAPI.js, line 3842

Copies the vertex, attribute, and material information from the given Geometry into this GeometryEditor. Please note that in many cases, this function operates asyncronously since the Geometry being copied may no be loaded yet. Consequently, using this GeometryEditor to operate on the copied Geometry will need to wait until the source Geomtry loads. This can be achieved by asyncronously awaiting this function, or by supplying a callback, which will be called when the source Geometry loads. The callback will receive the iniating GeometryEditor as its first parameter.

Parameters:

Name	Type	Attributes	Default	Description
geometry	Geometry			The source Geometry whose info will be copied into this GeometryEditor.
callbackOwner	object	<optional>		The object owning the callback that will be called when the source Geometry loads.
callbackName	string	<optional>		The name of the callback that will be called when the source Geometry loads.
callbackArgs	Array | any	<optional>		The arguments for the callback that will be called when the source Geometry loads.

deleteAllAttributesAndIndices()

IncisorAPI.js, line 3876

Deletes all attributes. This is typically used if the default attributes of 'position' and 'uv' are unneeded on a new GeometryEditor.

getBounds(attributeName, lowerBounds, upperBounds)

IncisorAPI.js, line 3913

Calculates the lowest and highest values seen on each dimension of the attribute's data.

Parameters:

Name	Type	Attributes	Default	Description
attributeName	string			The name of the attribute data to search for bounds. Defaults to 'position'.
lowerBounds	number			The array to populate with the lowest value found in each dimension of the attribute data.
upperBounds	number			The array to populate with the highest value found in each dimension of the attribute data.

getVertexTemplate()

IncisorAPI.js, line 3905

Returns a new object structured appropriately to pass into the addVertex and addTriangle functions. For each currently defined attribute, a member of type number, Vector2, Vector3, or Vector4 is added.

newGrid(width, height, horizontalSegments, verticalSegments)

IncisorAPI.js, line 3893

Creates a new grid of triangles oriented on the XY plane, centered around 0 on each axis.

Parameters:

Name	Type	Attributes	Default	Description
width	number			The width of the grid.
height	number			The height of the grid.
horizontalSegments	number			The number of horizontal segments of the grid.
verticalSegments	number			The number of vertical segments of the grid.

translate(translation, attributeName)

IncisorAPI.js, line 3900

Translates all of the values of an attribute by the given translation amount.

Parameters:

Name	Type	Attributes	Default	Description
translation	number | Vector2 | Vector3 | Vector4			The amount the values of the attribute are translated. This parameter should be a number, Vector2, Vector3, or Vector4. The type should correspond to the size of the attribute. For example, the default 'position' attribute should be translated by a Vector3, and the default 'uv' attribute should be translated by a Vector2.
attributeName	string			The name of the attribute data to be translated. Defaults to 'position'.