com.aspose.threed

Class VertexDeclaration

java.lang.Object

com.aspose.threed.VertexDeclaration

All Implemented Interfaces:

java.lang.Comparable<VertexDeclaration>, java.lang.Iterable<VertexField>

public final class VertexDeclaration
extends java.lang.Object
implements java.lang.Iterable<VertexField>, java.lang.Comparable<VertexDeclaration>

The declaration of a custom defined vertex's structure

Constructor Summary

Constructors

Constructor and Description
VertexDeclaration()

Method Summary

Modifier and Type	Method and Description
VertexField	addField(int dataType, VertexFieldSemantic semantic) Add a new vertex field
VertexField	addField(int dataType, VertexFieldSemantic semantic, int index) Add a new vertex field
VertexField	addField(int dataType, VertexFieldSemantic semantic, int index, java.lang.String alias) Add a new vertex field
void	clear() Clear all fields.
int	compareTo(VertexDeclaration other) Compares this instance to a specified object and returns an indication of their relative values.
boolean	equals(java.lang.Object obj) Determines whether this instance and a specified object, which must also be a VertexDeclaration object, have the same value.
static VertexDeclaration	fromGeometry(Geometry geometry, boolean useFloat) Create a VertexDeclaration based on a Geometry's layout.
VertexField	get(int index) Gets the VertexField by index
int	getCount() Gets the count of all fields defined in this VertexDeclaration
boolean	getSealed() A VertexDeclaration will be sealed when its been used by TriMesh, no more modifications is allowed.
int	getSize() The size in byte of the vertex structure.
int	hashCode() Returns the hash code for this string.
java.util.Iterator<VertexField>	iterator() Gets an enumerator to walk through all vertex fields in this instance.
java.lang.String	toString() String representation of VertexDeclaration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

VertexDeclaration

public VertexDeclaration()

Method Detail

getSealed

public boolean getSealed()

A VertexDeclaration will be sealed when its been used by TriMesh, no more modifications is allowed.

Returns:

A VertexDeclaration will be sealed when its been used by TriMesh, no more modifications is allowed.

getCount

public int getCount()

Gets the count of all fields defined in this VertexDeclaration

Returns:

the count of all fields defined in this VertexDeclaration

get

public VertexField get(int index)

Gets the VertexField by index

Returns:

the VertexField by index

clear

public void clear()

Clear all fields.

addField

public VertexField addField(int dataType,
                            VertexFieldSemantic semantic,
                            int index,
                            java.lang.String alias)

Add a new vertex field

Parameters:

dataType - The data type of the vertex field

semantic - How will this field used for

index - The index for same field semantic, -1 for auto-generation

alias - The alias name of the field

addField

public VertexField addField(int dataType,
                            VertexFieldSemantic semantic)

Add a new vertex field

Parameters:

dataType - The data type of the vertex field

semantic - How will this field used for

addField

public VertexField addField(int dataType,
                            VertexFieldSemantic semantic,
                            int index)

Add a new vertex field

Parameters:

dataType - The data type of the vertex field

semantic - How will this field used for

index - The index for same field semantic, -1 for auto-generation

fromGeometry

public static VertexDeclaration fromGeometry(Geometry geometry,
                                             boolean useFloat)

Create a VertexDeclaration based on a Geometry's layout.

Parameters:

useFloat - Use float instead of double type

getSize

public int getSize()

The size in byte of the vertex structure.

Returns:

The size in byte of the vertex structure.

compareTo

public int compareTo(VertexDeclaration other)

Compares this instance to a specified object and returns an indication of their relative values.

Specified by:

compareTo in interface java.lang.Comparable<VertexDeclaration>

toString

public java.lang.String toString()

String representation of VertexDeclaration

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Determines whether this instance and a specified object, which must also be a VertexDeclaration object, have the same value.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns the hash code for this string.

Overrides:

hashCode in class java.lang.Object

Returns:

A 32-bit signed integer hash code.

iterator

public java.util.Iterator<VertexField> iterator()

Gets an enumerator to walk through all vertex fields in this instance.

Specified by:

iterator in interface java.lang.Iterable<VertexField>

Returns:

Enumerator