panda3d.core.GeomVertexFormat

from panda3d.core import GeomVertexFormat
class GeomVertexFormat

Bases: TypedWritableReferenceCount, GeomEnums

This class defines the physical layout of the vertex data stored within a Geom. The layout consists of a list of named columns, each of which has a numeric type and a size.

The columns are typically interleaved within a single array, but they may also be distributed among multiple different arrays; at the extreme, each column may be alone within its own array (which amounts to a parallel-array definition).

Thus, a GeomVertexFormat is really a list of GeomVertexArrayFormats, each of which contains a list of columns. However, a particular column name should not appear more than once in the format, even between different arrays.

There are a handful of standard pre-defined GeomVertexFormat objects, or you may define your own as needed. You may record any combination of standard and/or user-defined columns in your custom GeomVertexFormat constructions.

Inheritance diagram

Inheritance diagram of GeomVertexFormat

__init__() → None
__init__(array_format: GeomVertexArrayFormat) → None
__init__(copy: GeomVertexFormat) → None
assign(copy: GeomVertexFormat) → GeomVertexFormat
Return type

GeomVertexFormat

unref() → bool

This method overrides ReferenceCount.unref() to unregister the object when its reference count goes to zero.

isRegistered() → bool

Returns true if this format has been registered, false if it has not. It may not be used for a Geom until it has been registered, but once registered, it may no longer be modified.

static registerFormat(format: GeomVertexArrayFormat) → GeomVertexFormat

This flavor of registerFormat() implicitly creates a one-array vertex format from the array definition.

Return type

GeomVertexFormat

static registerFormat(format: GeomVertexFormat) → GeomVertexFormat

Adds the indicated format to the registry, if there is not an equivalent format already there; in either case, returns the pointer to the equivalent format now in the registry.

This must be called before a format may be used in a Geom. After this call, you should discard the original pointer you passed in (which may or may not now be invalid) and let its reference count decrement normally; you should use only the returned value from this point on.

Return type

GeomVertexFormat

getAnimation() → GeomVertexAnimationSpec

Returns the GeomVertexAnimationSpec that indicates how this format’s vertices are set up for animation.

Return type

GeomVertexAnimationSpec

setAnimation(animation: GeomVertexAnimationSpec) → None

Resets the GeomVertexAnimationSpec that indicates how this format’s vertices are set up for animation. You should also, of course, change the columns in the tables accordingly.

This may not be called once the format has been registered.

getPostAnimatedFormat() → GeomVertexFormat

Returns a suitable vertex format for sending the animated vertices to the graphics backend. This is the same format as the source format, with the CPU-animation data elements removed.

This may only be called after the format has been registered. The return value will have been already registered.

Return type

GeomVertexFormat

getUnionFormat(other: GeomVertexFormat) → GeomVertexFormat

Returns a new GeomVertexFormat that includes all of the columns defined in either this GeomVertexFormat or the other one. If any column is defined in both formats with different sizes (for instance, texcoord2 vs. texcoord3), the new format will include the larger of the two definitions.

This may only be called after both source formats have been registered. The return value will also have been already registered.

Return type

GeomVertexFormat

getNumArrays() → size_t

Returns the number of individual arrays required by the format. If the array data is completely interleaved, this will be 1; if it is completely parallel, this will be the same as the number of data types.

Return type

size_t

getArray(array: size_t) → GeomVertexArrayFormat

Returns the description of the nth array used by the format.

Return type

GeomVertexArrayFormat

modifyArray(array: size_t) → GeomVertexArrayFormat

Returns a modifiable pointer to the indicated array. This means duplicating it if it is shared or registered.

This may not be called once the format has been registered.

Return type

GeomVertexArrayFormat

setArray(array: size_t, format: GeomVertexArrayFormat) → None

Replaces the definition of the indicated array.

This may not be called once the format has been registered.

removeArray(array: size_t) → None

Removes the nth array from the format.

This may not be called once the format has been registered.

addArray(array_format: GeomVertexArrayFormat) → size_t

Adds the indicated array definition to the list of arrays included within this vertex format definition. The return value is the index number of the new array.

This may not be called once the format has been registered.

Return type

size_t

insertArray(array: size_t, array_format: GeomVertexArrayFormat) → None

Adds the indicated array definition to the list of arrays at the indicated position. This works just like addArray(), except that you can specify which array index the new array should have.

This may not be called once the format has been registered.

clearArrays() → None

Removes all of the array definitions from the format and starts over.

This may not be called once the format has been registered.

removeEmptyArrays() → None

Removes the arrays that define no columns.

This may not be called once the format has been registered.

getNumColumns() → size_t

Returns the total number of different columns in the specification, across all arrays.

Return type

size_t

getArrayWith(name: InternalName) → int

Returns the index number of the array with the indicated column, or -1 if no arrays contained that name.

The return value can be passed to get_array_format() to get the format of the array. It may also be passed to GeomVertexData::get_array_data() or get_data() or set_data() to manipulate the actual array data.

This may only be called after the format has been registered.

getArrayWith(i: size_t) → int

Returns the index number of the array with the ith column.

The return value can be passed to get_array_format() to get the format of the array. It may also be passed to GeomVertexData::get_array_data() or get_data() or set_data() to manipulate the actual array data.

getColumn(name: InternalName) → GeomVertexColumn

Returns the specification with the indicated name, or NULL if the name is not used. Use getArrayWith() to determine which array this column is associated with.

Return type

GeomVertexColumn

getColumn(i: size_t) → GeomVertexColumn

Returns the ith column of the specification, across all arrays.

Return type

GeomVertexColumn

hasColumn(name: InternalName) → bool

Returns true if the format has the named column, false otherwise.

getColumnName(i: size_t) → InternalName

Returns the name of the ith column, across all arrays.

Return type

InternalName

removeColumn(name: InternalName, keep_empty_array: bool) → None

Removes the named column from the format, from whichever array it exists in. If there are other columns remaining in the array, the array is left with a gap where the column used to be; if this was the only column in the array, the array is removed (unless keep_empty_array is true).

This may not be called once the format has been registered.

packColumns() → None

Removes wasted space between columns.

alignColumnsForAnimation() → None

Reprocesses the columns in the format to align the C_point and C_vector columns to 16-byte boundaries to allow for the more efficient SSE2 operations (assuming SSE2 is enabled in the build).

Also see maybeAlignColumnsForAnimation().

maybeAlignColumnsForAnimation() → None

Calls alignColumnsForAnimation() if this format’s AnimationSpec indicates that it contains animated vertices, and if vertex-animation- align-16 is true.

getNumPoints() → size_t

Returns the number of columns within the format that represent points in space.

This may only be called after the format has been registered.

Return type

size_t

getPoint(n: size_t) → InternalName

Returns the name of the nth point column. This represents a point in space, which should be transformed by any spatial transform matrix.

This may only be called after the format has been registered.

Return type

InternalName

getNumVectors() → size_t

Returns the number of columns within the format that represent directional vectors.

This may only be called after the format has been registered.

Return type

size_t

getVector(n: size_t) → InternalName

Returns the name of the nth vector column. This represents a directional vector, which should be transformed by any spatial transform matrix as a vector.

This may only be called after the format has been registered.

Return type

InternalName

getNumTexcoords() → size_t

Returns the number of columns within the format that represent texture coordinates.

This may only be called after the format has been registered.

Return type

size_t

getTexcoord(n: size_t) → InternalName

Returns the name of the nth texcoord column. This represents a texture coordinate.

This may only be called after the format has been registered.

Return type

InternalName

getNumMorphs() → size_t

Returns the number of columns within the format that represent morph deltas.

This may only be called after the format has been registered.

Return type

size_t

getMorphSlider(n: size_t) → InternalName

Returns the slider name associated with the nth morph column. This is the name of the slider that will control the morph, and should be defined within the SliderTable associated with the GeomVertexData.

This may only be called after the format has been registered.

Return type

InternalName

getMorphBase(n: size_t) → InternalName

Returns the name of the base column that the nth morph modifies. This column will also be defined within the format, and can be retrieved via getArrayWith() and/or getColumn().

This may only be called after the format has been registered.

Return type

InternalName

getMorphDelta(n: size_t) → InternalName

Returns the name of the column that defines the nth morph. This contains the delta offsets that are to be applied to the column defined by getMorphBase(). This column will be defined within the format, and can be retrieved via getArrayWith() and/or getColumn().

This may only be called after the format has been registered.

Return type

InternalName

output(out: ostream) → None
write(out: ostream, indent_level: int) → None
writeWithData(out: ostream, indent_level: int, data: GeomVertexData) → None
static getEmpty() → GeomVertexFormat

Returns a standard vertex format containing no arrays at all, useful for pull-style vertex rendering.

Return type

GeomVertexFormat

static getV3() → GeomVertexFormat

Some standard vertex formats. No particular requirement to use one of these, but the DirectX renderers can use these formats directly, whereas any other format will have to be converted first.

Return type

GeomVertexFormat

static getV3n3() → GeomVertexFormat

Returns a standard vertex format with a 3-component normal and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3t2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3n3t2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair, a 3-component normal, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3cp() → GeomVertexFormat

These formats, with the DirectX-style packed color, may not be supported directly by OpenGL. If you use them and the driver does not support them, the GLGraphicsStateGuardian will automatically convert to native OpenGL form (with a small runtime overhead).

Return type

GeomVertexFormat

static getV3cpt2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair, a packed color, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3n3cp() → GeomVertexFormat

Returns a standard vertex format with a packed color, a 3-component normal, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3n3cpt2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair, a packed color, a 3-component normal, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3c4() → GeomVertexFormat

These formats, with an OpenGL-style four-byte color, are not supported directly by DirectX. If you use them, the DXGraphicsStateGuardian will automatically convert to DirectX form (with a larger runtime overhead, since DirectX8, and old DirectX9 drivers, require everything to be interleaved together).

Return type

GeomVertexFormat

static getV3c4t2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair, a 4-component color, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3n3c4() → GeomVertexFormat

Returns a standard vertex format with a 4-component color, a 3-component normal, and a 3-component vertex position.

Return type

GeomVertexFormat

static getV3n3c4t2() → GeomVertexFormat

Returns a standard vertex format with a 2-component texture coordinate pair, a 4-component color, a 3-component normal, and a 3-component vertex position.

Return type

GeomVertexFormat

static getClassType() → TypeHandle
Return type

TypeHandle

getArrays() → list
getColumns() → list
getPoints() → list
getVectors() → list
getTexcoords() → list
getMorphSliders() → list
getMorphBases() → list
getMorphDeltas() → list
property registered

Returns true if this format has been registered, false if it has not. It may not be used for a Geom until it has been registered, but once registered, it may no longer be modified.

Return type

bool

property animation
Getter

Returns the GeomVertexAnimationSpec that indicates how this format’s vertices are set up for animation.

Setter

Resets the GeomVertexAnimationSpec that indicates how this format’s vertices are set up for animation. You should also, of course, change the columns in the tables accordingly.

This may not be called once the format has been registered.

Return type

GeomVertexAnimationSpec

property arrays
Getter

Returns the description of the nth array used by the format.

Setter

Replaces the definition of the indicated array.

This may not be called once the format has been registered.

Return type

Sequence[GeomVertexArrayFormat]

property points

Returns the name of the nth point column. This represents a point in space, which should be transformed by any spatial transform matrix.

This may only be called after the format has been registered.

Return type

Sequence[InternalName]

property vectors

Returns the name of the nth vector column. This represents a directional vector, which should be transformed by any spatial transform matrix as a vector.

This may only be called after the format has been registered.

Return type

Sequence[InternalName]

property columns

We also define this as a mapping interface, for lookups by name.

Returns the ith column of the specification, across all arrays.

Returns the specification with the indicated name, or NULL if the name is not used. Use getArrayWith() to determine which array this column is associated with.

Return type

Mapping[GeomVertexColumn]