Panda3D
|
This describes the structure of a single array within a Geom data. More...
Public Member Functions | |
__init__ () | |
__init__ (const InternalName name0, int num_components0, GeomEnums::NumericType numeric_type0, GeomEnums::Contents contents0) | |
__init__ (const InternalName name0, int num_components0, GeomEnums::NumericType numeric_type0, GeomEnums::Contents contents0, const InternalName name1, int num_components1, GeomEnums::NumericType numeric_type1, GeomEnums::Contents contents1) | |
__init__ (const InternalName name0, int num_components0, GeomEnums::NumericType numeric_type0, GeomEnums::Contents contents0, const InternalName name1, int num_components1, GeomEnums::NumericType numeric_type1, GeomEnums::Contents contents1, const InternalName name2, int num_components2, GeomEnums::NumericType numeric_type2, GeomEnums::Contents contents2) | |
__init__ (const InternalName name0, int num_components0, GeomEnums::NumericType numeric_type0, GeomEnums::Contents contents0, const InternalName name1, int num_components1, GeomEnums::NumericType numeric_type1, GeomEnums::Contents contents1, const InternalName name2, int num_components2, GeomEnums::NumericType numeric_type2, GeomEnums::Contents contents2, const InternalName name3, int num_components3, GeomEnums::NumericType numeric_type3, GeomEnums::Contents contents3) | |
__init__ (const GeomVertexArrayFormat copy) | |
int | addColumn (const InternalName name, int num_components, GeomEnums::NumericType numeric_type, GeomEnums::Contents contents, int start, int column_alignment) |
Adds a new column to the specification. More... | |
int | addColumn (const GeomVertexColumn column) |
Adds a new column to the specification. More... | |
alignColumnsForAnimation () | |
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). More... | |
clearColumns () | |
Removes all columns previously added, sets the stride to zero, and prepares to start over. More... | |
int | countUnusedSpace () |
Returns the number of bytes per row that are not assigned to any column. More... | |
const GeomVertexColumn | getColumn (const InternalName name) |
Returns the specification with the indicated name, or NULL if the name is not used. More... | |
const GeomVertexColumn | getColumn (int i) |
Returns the ith column of the array. More... | |
const GeomVertexColumn | getColumn (int start_byte, int num_bytes) |
Returns the first specification that overlaps with any of the indicated bytes in the range, or NULL if none do. More... | |
list | getColumns () |
int | getDivisor () |
Returns the divisor attribute for the data in this array. More... | |
str | getFormatString (bool pad) |
Returns a string with format codes representing the exact memory layout of the columns in memory, as understood by Python's struct module. More... | |
int | getNumColumns () |
Returns the number of different columns in the array. More... | |
int | getPadTo () |
Returns the byte divisor to which the data record must be padded to meet hardware limitations. More... | |
int | getStride () |
Returns the total number of bytes reserved in the array for each vertex. More... | |
int | getTotalBytes () |
Returns the total number of bytes used by the data types within the format, including gaps between elements. More... | |
bool | hasColumn (const InternalName name) |
Returns true if the array has the named column, false otherwise. More... | |
bool | isDataSubsetOf (const GeomVertexArrayFormat other) |
Returns true if all of the fields in this array format are also present and equivalent in the other array format, and in the same byte positions, and the stride is the same. More... | |
bool | isRegistered () |
Returns true if this format has been registered, false if it has not. More... | |
GeomVertexArrayFormat | operator= (const GeomVertexArrayFormat copy) |
output (Ostream out) | |
packColumns () | |
Removes wasted space between columns. More... | |
removeColumn (const InternalName name) | |
Removes the column with the indicated name, if any. More... | |
setDivisor (int divisor) | |
Set this to 0 to indicate that this array contains per-vertex data, or to 1 to indicate that it contains per-instance data. More... | |
setPadTo (int pad_to) | |
Explicitly sets the byte divisor to which the data record must be padded to meet hardware limitations. More... | |
setStride (int stride) | |
Changes the total number of bytes reserved in the array for each vertex. More... | |
bool | unref () |
This method overrides ReferenceCount::unref() to unregister the object when its reference count goes to zero. More... | |
write (Ostream out, int indent_level) | |
writeWithData (Ostream out, int indent_level, const GeomVertexArrayData array_data) | |
![]() | |
object | __reduce__ () |
object | __reduce_persist__ (object pickler) |
VectorUchar | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More... | |
bool | encodeToBamStream (VectorUchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
fillin (DatagramIterator scan, BamReader manager) | |
This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More... | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. More... | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
![]() | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. More... | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. More... | |
![]() | |
int | getRefCount () |
Returns the current reference count. More... | |
ref () | |
Explicitly increments the reference count. More... | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | testRefCountNonzero () |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
bool | unref () |
Explicitly decrements the reference count. More... | |
![]() | |
__init__ () | |
__init__ (const GeomEnums) | |
Static Public Member Functions | |
static TypeHandle | getClassType () |
static const GeomVertexArrayFormat | registerFormat (const GeomVertexArrayFormat format) |
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. More... | |
![]() | |
static TypedWritableReferenceCount | decodeFromBamStream (VectorUchar data, BamReader reader) |
Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More... | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
Public Attributes | |
const GeomVertexColumn | columns [] |
int | divisor |
Returns the divisor attribute for the data in this array. More... | |
int | pad_to |
Returns the byte divisor to which the data record must be padded to meet hardware limitations. More... | |
bool | registered |
Returns true if this format has been registered, false if it has not. More... | |
int | stride |
Returns the total number of bytes reserved in the array for each vertex. More... | |
int | total_bytes |
Returns the total number of bytes used by the data types within the format, including gaps between elements. More... | |
![]() | |
TypeHandle | type |
Returns the TypeHandle representing this object's type. More... | |
![]() | |
int | ref_count |
The current reference count. More... | |
This describes the structure of a single array within a Geom data.
See GeomVertexFormat for the parent class which collects together all of the individual GeomVertexArrayFormat objects.
A particular array may include any number of standard or user-defined columns. All columns consist of a sequence of one or more numeric values, packed in any of a variety of formats; the semantic meaning of each column is defined in general with its contents member, and in particular by its name. The standard array types used most often are named "vertex", "normal", "texcoord", and "color"; other kinds of data may be piggybacked into the data record simply by choosing a unique name.
__init__ | ( | ) |
__init__ | ( | const InternalName | name0, |
int | num_components0, | ||
GeomEnums::NumericType | numeric_type0, | ||
GeomEnums::Contents | contents0 | ||
) |
__init__ | ( | const InternalName | name0, |
int | num_components0, | ||
GeomEnums::NumericType | numeric_type0, | ||
GeomEnums::Contents | contents0, | ||
const InternalName | name1, | ||
int | num_components1, | ||
GeomEnums::NumericType | numeric_type1, | ||
GeomEnums::Contents | contents1 | ||
) |
__init__ | ( | const InternalName | name0, |
int | num_components0, | ||
GeomEnums::NumericType | numeric_type0, | ||
GeomEnums::Contents | contents0, | ||
const InternalName | name1, | ||
int | num_components1, | ||
GeomEnums::NumericType | numeric_type1, | ||
GeomEnums::Contents | contents1, | ||
const InternalName | name2, | ||
int | num_components2, | ||
GeomEnums::NumericType | numeric_type2, | ||
GeomEnums::Contents | contents2 | ||
) |
__init__ | ( | const InternalName | name0, |
int | num_components0, | ||
GeomEnums::NumericType | numeric_type0, | ||
GeomEnums::Contents | contents0, | ||
const InternalName | name1, | ||
int | num_components1, | ||
GeomEnums::NumericType | numeric_type1, | ||
GeomEnums::Contents | contents1, | ||
const InternalName | name2, | ||
int | num_components2, | ||
GeomEnums::NumericType | numeric_type2, | ||
GeomEnums::Contents | contents2, | ||
const InternalName | name3, | ||
int | num_components3, | ||
GeomEnums::NumericType | numeric_type3, | ||
GeomEnums::Contents | contents3 | ||
) |
__init__ | ( | const GeomVertexArrayFormat | copy | ) |
int addColumn | ( | const InternalName | name, |
int | num_components, | ||
GeomEnums::NumericType | numeric_type, | ||
GeomEnums::Contents | contents, | ||
int | start, | ||
int | column_alignment | ||
) |
Adds a new column to the specification.
This is a table of per-vertex floating-point numbers such as "vertex" or "normal"; you must specify where in each record the table starts, and how many components (dimensions) exist per vertex.
The return value is the index number of the new data type.
int addColumn | ( | const GeomVertexColumn | column | ) |
Adds a new column to the specification.
This is a table of per-vertex floating-point numbers such as "vertex" or "normal"; you must specify where in each record the table starts, and how many components (dimensions) exist per vertex.
Adding a column with the same name as a previous type, or that overlaps with one or more previous types, quietly removes the previous type(s).
The return value is the index number of the new data type.
alignColumnsForAnimation | ( | ) |
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).
The caller is responsible for testing vertex_animation_align_16 to decide whether to call this method.
clearColumns | ( | ) |
Removes all columns previously added, sets the stride to zero, and prepares to start over.
int countUnusedSpace | ( | ) |
Returns the number of bytes per row that are not assigned to any column.
|
static |
const GeomVertexColumn getColumn | ( | const InternalName | name | ) |
Returns the specification with the indicated name, or NULL if the name is not used.
const GeomVertexColumn getColumn | ( | int | i | ) |
Returns the ith column of the array.
const GeomVertexColumn getColumn | ( | int | start_byte, |
int | num_bytes | ||
) |
Returns the first specification that overlaps with any of the indicated bytes in the range, or NULL if none do.
list getColumns | ( | ) |
int getDivisor | ( | ) |
Returns the divisor attribute for the data in this array.
If 0, it contains per-vertex data. If 1, it contains per-instance data. If higher than 1, the read row is advanced for each n instances.
str getFormatString | ( | bool | pad | ) |
Returns a string with format codes representing the exact memory layout of the columns in memory, as understood by Python's struct module.
If pad is true, extra padding bytes are added to the end as 'x' characters as needed.
int getNumColumns | ( | ) |
Returns the number of different columns in the array.
int getPadTo | ( | ) |
Returns the byte divisor to which the data record must be padded to meet hardware limitations.
For instance, if this is 4, the stride will be automatically rounded up to the next multiple of 4 bytes. This value is automatically increased as needed to ensure the individual numeric components in the array are word-aligned.
int getStride | ( | ) |
Returns the total number of bytes reserved in the array for each vertex.
int getTotalBytes | ( | ) |
Returns the total number of bytes used by the data types within the format, including gaps between elements.
bool hasColumn | ( | const InternalName | name | ) |
Returns true if the array has the named column, false otherwise.
bool isDataSubsetOf | ( | const GeomVertexArrayFormat | other | ) |
Returns true if all of the fields in this array format are also present and equivalent in the other array format, and in the same byte positions, and the stride is the same.
That is, true if this format can share the same data pointer as the other format (with possibly some unused gaps).
bool isRegistered | ( | ) |
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.
GeomVertexArrayFormat operator= | ( | const GeomVertexArrayFormat | copy | ) |
output | ( | Ostream | out | ) |
packColumns | ( | ) |
Removes wasted space between columns.
|
static |
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 is similar to GeomVertexFormat::register_format(), except that you generally need not call it explicitly. Calling GeomVertexFormat::register_format() automatically registers all of the nested array formats.
removeColumn | ( | const InternalName | name | ) |
Removes the column with the indicated name, if any.
This leaves a gap in the byte structure.
setDivisor | ( | int | divisor | ) |
Set this to 0 to indicate that this array contains per-vertex data, or to 1 to indicate that it contains per-instance data.
If higher than 1, the read row is advanced for each n instances.
setPadTo | ( | int | pad_to | ) |
Explicitly sets the byte divisor to which the data record must be padded to meet hardware limitations.
See get_pad_to(). Normally it is not necessary to call this unless you have some specific requirements for row-to-row data alignment. Note that this value may be automatically increased at each subsequent call to add_column().
setStride | ( | int | stride | ) |
Changes the total number of bytes reserved in the array for each vertex.
You may not reduce this below get_total_bytes(), but you may increase it arbitrarily.
bool unref | ( | ) |
This method overrides ReferenceCount::unref() to unregister the object when its reference count goes to zero.
write | ( | Ostream | out, |
int | indent_level | ||
) |
writeWithData | ( | Ostream | out, |
int | indent_level, | ||
const GeomVertexArrayData | array_data | ||
) |
const GeomVertexColumn columns[] |
int divisor |
Returns the divisor attribute for the data in this array.
If 0, it contains per-vertex data. If 1, it contains per-instance data. If higher than 1, the read row is advanced for each n instances.
int pad_to |
Returns the byte divisor to which the data record must be padded to meet hardware limitations.
For instance, if this is 4, the stride will be automatically rounded up to the next multiple of 4 bytes. This value is automatically increased as needed to ensure the individual numeric components in the array are word-aligned.
bool 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.
int stride |
Returns the total number of bytes reserved in the array for each vertex.
int total_bytes |
Returns the total number of bytes used by the data types within the format, including gaps between elements.