Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GeomPrimitive Class Reference

This is an abstract base class for a family of classes that represent the fundamental geometry primitives that may be stored in a Geom. More...

Inheritance diagram for GeomPrimitive:
CopyOnWriteObject GeomEnums CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject GeomLines GeomLinesAdjacency GeomLinestrips GeomLinestripsAdjacency GeomPatches GeomPoints GeomTriangles GeomTrianglesAdjacency GeomTrifans GeomTristrips GeomTristripsAdjacency

Public Member Functions

 addConsecutiveVertices (int start, int num_vertices)
 Adds a consecutive sequence of vertices, beginning at start, to the primitive. More...
 
 addNextVertices (int num_vertices)
 Adds the next n vertices in sequence, beginning from the last vertex added to the primitive + 1. More...
 
 addVertex (int vertex)
 Adds the indicated vertex to the list of vertex indices used by the graphics primitive type. More...
 
 addVertices (int v1, int v2)
 Adds several vertices in a row. More...
 
 addVertices (int v1, int v2, int v3)
 Adds several vertices in a row. More...
 
 addVertices (int v1, int v2, int v3, int v4)
 Adds several vertices in a row. More...
 
bool checkValid (const GeomVertexData vertex_data)
 Verifies that the primitive only references vertices that actually exist within the indicated GeomVertexData. More...
 
bool checkValid (const GeomVertexDataPipelineReader data_reader)
 
 clearMinmax ()
 Undoes a previous call to set_minmax(), and allows the minimum and maximum values to be recomputed normally. More...
 
 clearVertices ()
 Removes all of the vertices and primitives from the object, so they can be re-added. More...
 
bool closePrimitive ()
 Indicates that the previous n calls to add_vertex(), since the last call to close_primitive(), have fully defined a new primitive. More...
 
const GeomPrimitive decompose ()
 Decomposes a complex primitive type into a simpler primitive type, for instance triangle strips to triangles, and returns a pointer to the new primitive definition. More...
 
const GeomPrimitive doubleside ()
 Duplicates triangles in the primitive so that each triangle is back-to-back with another triangle facing in the opposite direction. More...
 
int getDataSizeBytes ()
 Returns the number of bytes stored in the vertices array. More...
 
CPTAInt getEnds ()
 Returns a const pointer to the primitive ends array so application code can read it directly. More...
 
int getFirstVertex ()
 Returns the first vertex number referenced by the primitive. More...
 
int getGeomRendering ()
 Returns the set of GeomRendering bits that represent the rendering properties required to properly render this primitive. More...
 
int getIndexStride ()
 A convenience function to return the gap between successive index numbers, in bytes, of the index data. More...
 
GeomEnums::NumericType getIndexType ()
 Returns the numeric type of the index column. More...
 
const GeomVertexArrayData getMaxs ()
 Returns a const pointer to the primitive maxs array so application code can read it directly. More...
 
int getMaxVertex ()
 Returns the maximum vertex index number used by all the primitives in this object. More...
 
int getMinNumVerticesPerPrimitive ()
 Returns the minimum number of vertices that must be added before close_primitive() may legally be called. More...
 
const GeomVertexArrayData getMins ()
 Returns a const pointer to the primitive mins array so application code can read it directly. More...
 
int getMinVertex ()
 Returns the minimum vertex index number used by all the primitives in this object. More...
 
UpdateSeq getModified ()
 Returns a sequence number which is guaranteed to change at least every time the vertex index array is modified. More...
 
int getNumBytes ()
 Returns the number of bytes consumed by the primitive and its index table(s). More...
 
int getNumFaces ()
 Returns the number of triangles or other fundamental type (such as line segments) represented by all the primitives in this object. More...
 
int getNumPrimitives ()
 Returns the number of individual primitives stored within this object. More...
 
int getNumUnusedVerticesPerPrimitive ()
 Returns the number of vertices that are added between primitives that aren't, strictly speaking, part of the primitives themselves. More...
 
int getNumUsedVertices ()
 Returns the number of vertices used by all of the primitives. More...
 
int getNumVertices ()
 Returns the number of indices used by all the primitives in this object. More...
 
int getNumVerticesPerPrimitive ()
 If the primitive type is a simple type in which all primitives have the same number of vertices, like triangles, returns the number of vertices per primitive. More...
 
int getPrimitiveEnd (int n)
 Returns the element within the _vertices list at which the nth primitive ends. More...
 
int getPrimitiveMaxVertex (int n)
 Returns the maximum vertex index number used by the nth primitive in this object. More...
 
int getPrimitiveMinVertex (int n)
 Returns the minimum vertex index number used by the nth primitive in this object. More...
 
int getPrimitiveNumFaces (int n)
 Returns the number of triangles or other fundamental type (such as line segments) represented by the nth primitive in this object. More...
 
int getPrimitiveNumVertices (int n)
 Returns the number of vertices used by the nth primitive. More...
 
int getPrimitiveStart (int n)
 Returns the element within the _vertices list at which the nth primitive starts. More...
 
GeomEnums::PrimitiveType getPrimitiveType ()
 
GeomEnums::ShadeModel getShadeModel ()
 Returns the ShadeModel hint for this primitive. More...
 
int getStripCutIndex ()
 If relevant, returns the index value that may be used in some cases to signify the end of a primitive. More...
 
GeomEnums::UsageHint getUsageHint ()
 Returns the usage hint for this primitive. More...
 
int getVertex (int i)
 Returns the ith vertex index in the table. More...
 
list getVertexList ()
 
const GeomVertexArrayData getVertices ()
 Returns a const pointer to the vertex index array so application code can read it directly. More...
 
const GeomVertexArrayDataHandle getVerticesHandle (Thread current_thread)
 Equivalent to get_vertices().get_handle(). More...
 
bool isComposite ()
 Returns true if the primitive is a composite primitive such as a tristrip or trifan, or false if it is a fundamental primitive such as a collection of triangles. More...
 
bool isIndexed ()
 Returns true if the primitive is indexed, false otherwise. More...
 
const GeomPrimitive makeAdjacency ()
 Adds adjacency information to this primitive. More...
 
GeomPrimitive makeCopy ()
 
 makeIndexed ()
 Converts the primitive from nonindexed form to indexed form. More...
 
const GeomPrimitive makeLines ()
 Returns a new GeomLines primitive that represents each of the edges in the original primitive rendered as a line. More...
 
 makeNonindexed (GeomVertexData dest, const GeomVertexData source)
 Converts the primitive from indexed to nonindexed by duplicating vertices as necessary into the indicated dest GeomVertexData. More...
 
const GeomPrimitive makePatches ()
 Decomposes a complex primitive type into a simpler primitive type, for instance triangle strips to triangles, puts these in a new GeomPatches object and returns a pointer to the new primitive definition. More...
 
const GeomPrimitive makePoints ()
 Returns a new GeomPoints primitive that represents each of the vertices in the original primitive, rendered exactly once. More...
 
const GeomPrimitive matchShadeModel (GeomEnums::ShadeModel shade_model)
 Returns a new primitive that is compatible with the indicated shade model, if possible, or NULL if this is not possible. More...
 
PTAInt modifyEnds ()
 Returns a modifiable pointer to the primitive ends array, so application code can directly fiddle with this data. More...
 
GeomVertexArrayData modifyVertices (int num_vertices)
 Returns a modifiable pointer to the vertex index list, so application code can directly fiddle with this data. More...
 
GeomVertexArrayDataHandle modifyVerticesHandle (Thread current_thread)
 Equivalent to modify_vertices().get_handle(). More...
 
 offsetVertices (int offset)
 Adds the indicated offset to all vertices used by the primitive. More...
 
 offsetVertices (int offset, int begin_row, int end_row)
 Adds the indicated offset to the indicated segment of vertices used by the primitive. More...
 
 operator new (int size)
 
GeomPrimitive operator= (const GeomPrimitive copy)
 
 output (Ostream out)
 
 packVertices (GeomVertexData dest, const GeomVertexData source)
 Packs the vertices used by the primitive from the indicated source array onto the end of the indicated destination array. More...
 
bool requestResident (Thread current_thread)
 Returns true if the primitive data is currently resident in memory. More...
 
 reserveNumVertices (int num_vertices)
 This ensures that enough memory space for n vertices is allocated, so that you may increase the number of vertices to n without causing a new memory allocation. More...
 
const GeomPrimitive reverse ()
 Reverses the winding order in the primitive so that each triangle is facing in the opposite direction it was originally. More...
 
const GeomPrimitive rotate ()
 Returns a new primitive with the shade_model reversed (if it is flat shaded), if possible. More...
 
 setEnds (PTAInt ends)
 Completely replaces the primitive ends array with a new table. More...
 
 setIndexType (GeomEnums::NumericType index_type)
 Changes the numeric type of the index column. More...
 
 setMinmax (int min_vertex, int max_vertex, GeomVertexArrayData mins, GeomVertexArrayData maxs)
 Explicitly specifies the minimum and maximum vertices, as well as the lists of per-component min and max. More...
 
 setNonindexedVertices (int first_vertex, int num_vertices)
 Sets the primitive up as a nonindexed primitive, using the indicated vertex range. More...
 
 setShadeModel (GeomEnums::ShadeModel shade_model)
 Changes the ShadeModel hint for this primitive. More...
 
 setUsageHint (GeomEnums::UsageHint usage_hint)
 Changes the UsageHint hint for this primitive. More...
 
 setVertices (const GeomVertexArrayData vertices, int num_vertices)
 Completely replaces the vertex index list with a new table. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from CopyOnWriteObject
 cacheRef ()
 
bool cacheUnref ()
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
 cacheRef ()
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
bool cacheUnref ()
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int getCacheRefCount ()
 Returns the current reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from TypedWritable
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...
 
- Public Member Functions inherited from TypedObject
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...
 
- Public Member Functions inherited from ReferenceCount
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...
 
- Public Member Functions inherited from GeomEnums
 __init__ ()
 
 __init__ (const GeomEnums)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CopyOnWriteObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
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 Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

int data_size_bytes
 Returns the number of bytes stored in the vertices array. More...
 
int geom_rendering
 Returns the set of GeomRendering bits that represent the rendering properties required to properly render this primitive. More...
 
int index_stride
 A convenience function to return the gap between successive index numbers, in bytes, of the index data. More...
 
GeomEnums::NumericType index_type
 Returns the numeric type of the index column. More...
 
ConstPointerToGeomVertexArrayData maxs
 Returns a const pointer to the primitive maxs array so application code can read it directly. More...
 
int min_num_vertices_per_primitive
 Returns the minimum number of vertices that must be added before close_primitive() may legally be called. More...
 
ConstPointerToGeomVertexArrayData mins
 Returns a const pointer to the primitive mins array so application code can read it directly. More...
 
UpdateSeq modified
 Returns a sequence number which is guaranteed to change at least every time the vertex index array is modified. More...
 
int num_bytes
 Returns the number of bytes consumed by the primitive and its index table(s). More...
 
int num_unused_vertices_per_primitive
 Returns the number of vertices that are added between primitives that aren't, strictly speaking, part of the primitives themselves. More...
 
int num_vertices_per_primitive
 If the primitive type is a simple type in which all primitives have the same number of vertices, like triangles, returns the number of vertices per primitive. More...
 
GeomEnums::PrimitiveType primitive_type
 
GeomEnums::ShadeModel shade_model
 Returns the ShadeModel hint for this primitive. More...
 
int strip_cut_index
 If relevant, returns the index value that may be used in some cases to signify the end of a primitive. More...
 
GeomEnums::UsageHint usage_hint
 Returns the usage hint for this primitive. More...
 
- Public Attributes inherited from CachedTypedWritableReferenceCount
int cache_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Additional Inherited Members

- Public Types inherited from GeomEnums
enum  AnimationType { AT_none = 0, AT_panda = 1, AT_hardware = 2 }
 
enum  Contents {
  C_other = 0, C_point = 1, C_clip_point = 2, C_vector = 3,
  C_texcoord = 4, C_color = 5, C_index = 6, C_morph_delta = 7,
  C_matrix = 8, C_normal = 9
}
 
enum  GeomRendering {
  GR_indexed_point = 1, GR_indexed_other = 65536, GR_indexed_bits = 65537, GR_point = 2,
  GR_point_uniform_size = 4, GR_per_point_size = 8, GR_point_perspective = 16, GR_point_aspect_ratio = 32,
  GR_point_scale = 64, GR_point_rotate = 128, GR_point_sprite = 256, GR_point_sprite_tex_matrix = 512,
  GR_point_bits = 1022, GR_triangle_strip = 1024, GR_triangle_fan = 2048, GR_line_strip = 4096,
  GR_composite_bits = 7168, GR_strip_cut_index = 131072, GR_flat_first_vertex = 8192, GR_flat_last_vertex = 16384,
  GR_shade_model_bits = 24576, GR_render_mode_wireframe = 262144, GR_render_mode_point = 524288, GR_adjacency = 1048576
}
 
enum  NumericType {
  NT_uint8 = 0, NT_uint16 = 1, NT_uint32 = 2, NT_packed_dcba = 3,
  NT_packed_dabc = 4, NT_float32 = 5, NT_float64 = 6, NT_stdfloat = 7,
  NT_int8 = 8, NT_int16 = 9, NT_int32 = 10, NT_packed_ufloat = 11
}
 
enum  PrimitiveType {
  PT_none = 0, PT_polygons = 1, PT_lines = 2, PT_points = 3,
  PT_patches = 4
}
 
enum  ShadeModel { SM_uniform = 0, SM_smooth = 1, SM_flat_first_vertex = 2, SM_flat_last_vertex = 3 }
 
enum  UsageHint {
  UH_client = 0, UH_stream = 1, UH_dynamic = 2, UH_static = 3,
  UH_unspecified = 4
}
 

Detailed Description

This is an abstract base class for a family of classes that represent the fundamental geometry primitives that may be stored in a Geom.

They all have in common the fact that they are defined by tables of vertex data stored in a GeomVertexData object. Each GeomPrimitive object contains an ordered list of integers, which index into the vertex array defined by the GeomVertexData and define the particular vertices of the GeomVertexData that are used for this primitive.

The meaning of a given arrangement of vertices is defined by each individual primitive type; for instance, a GeomTriangle renders a triangle from each three consecutive vertices, while a GeomTriangleStrip renders a strip of (n - 2) connected triangles from each sequence of n vertices.

Member Function Documentation

◆ addConsecutiveVertices()

addConsecutiveVertices ( int  start,
int  num_vertices 
)

Adds a consecutive sequence of vertices, beginning at start, to the primitive.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ addNextVertices()

addNextVertices ( int  num_vertices)

Adds the next n vertices in sequence, beginning from the last vertex added to the primitive + 1.

This is most useful when you are building up a primitive and a GeomVertexData at the same time, and you just want the primitive to reference the first n vertices from the data, then the next n, and so on.

◆ addVertex()

addVertex ( int  vertex)

Adds the indicated vertex to the list of vertex indices used by the graphics primitive type.

To define a primitive, you must call add_vertex() for each vertex of the new primitive, and then call close_primitive() after you have specified the last vertex of each primitive.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ addVertices() [1/3]

addVertices ( int  v1,
int  v2 
)

Adds several vertices in a row.

◆ addVertices() [2/3]

addVertices ( int  v1,
int  v2,
int  v3 
)

Adds several vertices in a row.

◆ addVertices() [3/3]

addVertices ( int  v1,
int  v2,
int  v3,
int  v4 
)

Adds several vertices in a row.

◆ checkValid() [1/2]

bool checkValid ( const GeomVertexData  vertex_data)

Verifies that the primitive only references vertices that actually exist within the indicated GeomVertexData.

Returns true if the primitive appears to be valid, false otherwise.

◆ checkValid() [2/2]

bool checkValid ( const GeomVertexDataPipelineReader  data_reader)

◆ clearMinmax()

clearMinmax ( )

Undoes a previous call to set_minmax(), and allows the minimum and maximum values to be recomputed normally.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ clearVertices()

clearVertices ( )

Removes all of the vertices and primitives from the object, so they can be re-added.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ closePrimitive()

bool closePrimitive ( )

Indicates that the previous n calls to add_vertex(), since the last call to close_primitive(), have fully defined a new primitive.

Returns true if successful, false otherwise.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ decompose()

const GeomPrimitive decompose ( )

Decomposes a complex primitive type into a simpler primitive type, for instance triangle strips to triangles, and returns a pointer to the new primitive definition.

If the decomposition cannot be performed, this might return the original object.

This method is useful for application code that wants to iterate through the set of triangles on the primitive without having to write handlers for each possible kind of primitive type.

◆ doubleside()

const GeomPrimitive doubleside ( )

Duplicates triangles in the primitive so that each triangle is back-to-back with another triangle facing in the opposite direction.

Note that this doesn't affect vertex normals, so this operation alone won't work in the presence of lighting (but see SceneGraphReducer::doubleside()).

Also see CullFaceAttrib, which can enable rendering of both sides of a triangle without having to duplicate it (but which doesn't necessarily work in the presence of lighting).

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDataSizeBytes()

int getDataSizeBytes ( )

Returns the number of bytes stored in the vertices array.

◆ getEnds()

CPTAInt getEnds ( )

Returns a const pointer to the primitive ends array so application code can read it directly.

Do not attempt to modify the returned array; use modify_ends() or set_ends() for this.

Note that simple primitive types, like triangles, do not have a ends array: since all the primitives have the same number of vertices, it is not needed.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getFirstVertex()

int getFirstVertex ( )

Returns the first vertex number referenced by the primitive.

This is particularly important in the case of a nonindexed primitive, in which case get_first_vertex() and get_num_vertices() completely define the extent of the vertex range.

◆ getGeomRendering()

int getGeomRendering ( )

Returns the set of GeomRendering bits that represent the rendering properties required to properly render this primitive.

◆ getIndexStride()

int getIndexStride ( )

A convenience function to return the gap between successive index numbers, in bytes, of the index data.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getIndexType()

GeomEnums::NumericType getIndexType ( )

Returns the numeric type of the index column.

Normally, this will be either NT_uint16 or NT_uint32.

◆ getMaxs()

const GeomVertexArrayData getMaxs ( )

Returns a const pointer to the primitive maxs array so application code can read it directly.

Do not attempt to modify the returned array; use set_minmax().

Note that simple primitive types, like triangles, do not have a maxs array.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getMaxVertex()

int getMaxVertex ( )

Returns the maximum vertex index number used by all the primitives in this object.

◆ getMinNumVerticesPerPrimitive()

int getMinNumVerticesPerPrimitive ( )

Returns the minimum number of vertices that must be added before close_primitive() may legally be called.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getMins()

const GeomVertexArrayData getMins ( )

Returns a const pointer to the primitive mins array so application code can read it directly.

Do not attempt to modify the returned array; use set_minmax() for this.

Note that simple primitive types, like triangles, do not have a mins array.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getMinVertex()

int getMinVertex ( )

Returns the minimum vertex index number used by all the primitives in this object.

◆ getModified()

UpdateSeq getModified ( )

Returns a sequence number which is guaranteed to change at least every time the vertex index array is modified.

◆ getNumBytes()

int getNumBytes ( )

Returns the number of bytes consumed by the primitive and its index table(s).

◆ getNumFaces()

int getNumFaces ( )

Returns the number of triangles or other fundamental type (such as line segments) represented by all the primitives in this object.

◆ getNumPrimitives()

int getNumPrimitives ( )

Returns the number of individual primitives stored within this object.

All primitives are the same type.

◆ getNumUnusedVerticesPerPrimitive()

int getNumUnusedVerticesPerPrimitive ( )

Returns the number of vertices that are added between primitives that aren't, strictly speaking, part of the primitives themselves.

This is used, for instance, to define degenerate triangles to connect otherwise disconnected triangle strips.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getNumUsedVertices()

int getNumUsedVertices ( )

Returns the number of vertices used by all of the primitives.

This is the same as summing get_primitive_num_vertices(n) for n in get_num_primitives(). It is like get_num_vertices except that it excludes all of the degenerate vertices and strip-cut indices.

◆ getNumVertices()

int getNumVertices ( )

Returns the number of indices used by all the primitives in this object.

◆ getNumVerticesPerPrimitive()

int getNumVerticesPerPrimitive ( )

If the primitive type is a simple type in which all primitives have the same number of vertices, like triangles, returns the number of vertices per primitive.

If the primitive type is a more complex type in which different primitives might have different numbers of vertices, for instance a triangle strip, returns 0.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getPrimitiveEnd()

int getPrimitiveEnd ( int  n)

Returns the element within the _vertices list at which the nth primitive ends.

This is one past the last valid element for the nth primitive.

◆ getPrimitiveMaxVertex()

int getPrimitiveMaxVertex ( int  n)

Returns the maximum vertex index number used by the nth primitive in this object.

◆ getPrimitiveMinVertex()

int getPrimitiveMinVertex ( int  n)

Returns the minimum vertex index number used by the nth primitive in this object.

◆ getPrimitiveNumFaces()

int getPrimitiveNumFaces ( int  n)

Returns the number of triangles or other fundamental type (such as line segments) represented by the nth primitive in this object.

◆ getPrimitiveNumVertices()

int getPrimitiveNumVertices ( int  n)

Returns the number of vertices used by the nth primitive.

This is the same thing as get_primitive_end(n) - get_primitive_start(n).

◆ getPrimitiveStart()

int getPrimitiveStart ( int  n)

Returns the element within the _vertices list at which the nth primitive starts.

If i is one more than the highest valid primitive vertex, the return value will be one more than the last valid vertex. Thus, it is generally true that the vertices used by a particular primitive i are the set get_primitive_start(n) <= vi < get_primitive_start(n + 1) (although this range also includes the unused vertices between primitives).

◆ getPrimitiveType()

GeomEnums::PrimitiveType getPrimitiveType ( )

◆ getShadeModel()

GeomEnums::ShadeModel getShadeModel ( )

Returns the ShadeModel hint for this primitive.

This is intended as a hint to the renderer to tell it how the per-vertex colors and normals are applied.

◆ getStripCutIndex()

int getStripCutIndex ( )

If relevant, returns the index value that may be used in some cases to signify the end of a primitive.

This is typically the highest value that the numeric type can store.

◆ getUsageHint()

GeomEnums::UsageHint getUsageHint ( )

Returns the usage hint for this primitive.

See geomEnums.h. This has nothing to do with the usage hint associated with the primitive's vertices; this only specifies how often the vertex indices that define the primitive will be modified.

It is perfectly legal (and, in fact, common) for a GeomPrimitive to have UH_static on itself, while referencing vertex data with UH_dynamic. This means that the vertices themselves will be animated, but the primitive will always reference the same set of vertices from the pool.

◆ getVertex()

int getVertex ( int  i)

Returns the ith vertex index in the table.

◆ getVertexList()

list getVertexList ( )

◆ getVertices()

const GeomVertexArrayData getVertices ( )

Returns a const pointer to the vertex index array so application code can read it directly.

This might return NULL if the primitive is nonindexed. Do not attempt to modify the returned array; use modify_vertices() or set_vertices() for this.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ getVerticesHandle()

const GeomVertexArrayDataHandle getVerticesHandle ( Thread  current_thread)

Equivalent to get_vertices().get_handle().

◆ isComposite()

bool isComposite ( )

Returns true if the primitive is a composite primitive such as a tristrip or trifan, or false if it is a fundamental primitive such as a collection of triangles.

◆ isIndexed()

bool isIndexed ( )

Returns true if the primitive is indexed, false otherwise.

An indexed primitive stores a table of index numbers into its GeomVertexData, so that it can reference the vertices in any order. A nonindexed primitive, on the other hand, stores only the first vertex number and number of vertices used, so that it can only reference the vertices consecutively.

◆ makeAdjacency()

const GeomPrimitive makeAdjacency ( )

Adds adjacency information to this primitive.

May return null if this type of geometry does not support adjacency information.

Since
1.10.0

◆ makeCopy()

GeomPrimitive makeCopy ( )

◆ makeIndexed()

makeIndexed ( )

Converts the primitive from nonindexed form to indexed form.

This will simply create an index table that is numbered consecutively from get_first_vertex(); it does not automatically collapse together identical vertices that may have been split apart by a previous call to make_nonindexed().

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ makeLines()

const GeomPrimitive makeLines ( )

Returns a new GeomLines primitive that represents each of the edges in the original primitive rendered as a line.

If the original primitive is already a GeomLines primitive, returns the original primitive unchanged.

◆ makeNonindexed()

makeNonindexed ( GeomVertexData  dest,
const GeomVertexData  source 
)

Converts the primitive from indexed to nonindexed by duplicating vertices as necessary into the indicated dest GeomVertexData.

Note: does not support primitives with strip cut indices.

◆ makePatches()

const GeomPrimitive makePatches ( )

Decomposes a complex primitive type into a simpler primitive type, for instance triangle strips to triangles, puts these in a new GeomPatches object and returns a pointer to the new primitive definition.

If the decomposition cannot be performed, this might return the original object.

This method is useful for application code that wants to use tesselation shaders on arbitrary geometry.

◆ makePoints()

const GeomPrimitive makePoints ( )

Returns a new GeomPoints primitive that represents each of the vertices in the original primitive, rendered exactly once.

If the original primitive is already a GeomPoints primitive, returns the original primitive unchanged.

◆ matchShadeModel()

const GeomPrimitive matchShadeModel ( GeomEnums::ShadeModel  shade_model)

Returns a new primitive that is compatible with the indicated shade model, if possible, or NULL if this is not possible.

In most cases, this will return either NULL or the original primitive. In the case of a SM_flat_first_vertex vs. a SM_flat_last_vertex (or vice- versa), however, it will return a rotated primitive.

◆ modifyEnds()

PTAInt modifyEnds ( )

Returns a modifiable pointer to the primitive ends array, so application code can directly fiddle with this data.

Use with caution, since there are no checks that the data will be left in a stable state.

Note that simple primitive types, like triangles, do not have a ends array: since all the primitives have the same number of vertices, it is not needed.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ modifyVertices()

GeomVertexArrayData modifyVertices ( int  num_vertices)

Returns a modifiable pointer to the vertex index list, so application code can directly fiddle with this data.

Use with caution, since there are no checks that the data will be left in a stable state.

If this is called on a nonindexed primitive, it will implicitly be converted to an indexed primitive.

If num_vertices is not -1, it specifies an artificial limit to the number of vertices in the array. Otherwise, all of the vertices in the array will be used.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ modifyVerticesHandle()

GeomVertexArrayDataHandle modifyVerticesHandle ( Thread  current_thread)

Equivalent to modify_vertices().get_handle().

◆ offsetVertices() [1/2]

offsetVertices ( int  offset)

Adds the indicated offset to all vertices used by the primitive.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ offsetVertices() [2/2]

offsetVertices ( int  offset,
int  begin_row,
int  end_row 
)

Adds the indicated offset to the indicated segment of vertices used by the primitive.

Unlike the other version of offset_vertices, this makes the geometry indexed if it isn't already.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ operator new()

operator new ( int  size)

◆ operator=()

GeomPrimitive operator= ( const GeomPrimitive  copy)

◆ output()

output ( Ostream  out)

◆ packVertices()

packVertices ( GeomVertexData  dest,
const GeomVertexData  source 
)

Packs the vertices used by the primitive from the indicated source array onto the end of the indicated destination array.

◆ requestResident()

bool requestResident ( Thread  current_thread)

Returns true if the primitive data is currently resident in memory.

If this returns false, the primitive data will be brought back into memory shortly; try again later.

◆ reserveNumVertices()

reserveNumVertices ( int  num_vertices)

This ensures that enough memory space for n vertices is allocated, so that you may increase the number of vertices to n without causing a new memory allocation.

This is a performance optimization only; it is especially useful when you know ahead of time that you will be adding n vertices to the primitive.

Note that the total you specify here should also include implicit vertices which may be added at each close_primitive() call, according to get_num_unused_vertices_per_primitive().

Note also that making this call will implicitly make the primitive indexed if it is not already, which could result in a performance penalty. If you would prefer not to lose the nonindexed nature of your existing GeomPrimitives, check is_indexed() before making this call.

◆ reverse()

const GeomPrimitive reverse ( )

Reverses the winding order in the primitive so that each triangle is facing in the opposite direction it was originally.

Note that this doesn't affect vertex normals, so this operation alone won't work in the presence of lighting (but see SceneGraphReducer::reverse()).

Also see CullFaceAttrib, which can change the visible direction of a triangle without having to duplicate it (but which doesn't necessarily work in the presence of lighting).

◆ rotate()

const GeomPrimitive rotate ( )

Returns a new primitive with the shade_model reversed (if it is flat shaded), if possible.

If the primitive type cannot be rotated, returns the original primitive, unrotated.

If the current shade_model indicates flat_vertex_last, this should bring the last vertex to the first position; if it indicates flat_vertex_first, this should bring the first vertex to the last position.

◆ setEnds()

setEnds ( PTAInt  ends)

Completely replaces the primitive ends array with a new table.

Chances are good that you should also replace the vertices list with set_vertices() at the same time.

Note that simple primitive types, like triangles, do not have a ends array: since all the primitives have the same number of vertices, it is not needed.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ setIndexType()

setIndexType ( GeomEnums::NumericType  index_type)

Changes the numeric type of the index column.

Normally, this should be either NT_uint16 or NT_uint32.

The index type must be large enough to include all of the index values in the primitive. It may be automatically elevated, if necessary, to a larger index type, by a subsequent call to add_index() that names an index value that does not fit in the index type you specify.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ setMinmax()

setMinmax ( int  min_vertex,
int  max_vertex,
GeomVertexArrayData  mins,
GeomVertexArrayData  maxs 
)

Explicitly specifies the minimum and maximum vertices, as well as the lists of per-component min and max.

Use this method with extreme caution. It's generally better to let the GeomPrimitive compute these explicitly, unless for some reason you can do it faster and you absolutely need the speed improvement.

Note that any modification to the vertex array will normally cause this to be recomputed, unless you set it immediately again.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ setNonindexedVertices()

setNonindexedVertices ( int  first_vertex,
int  num_vertices 
)

Sets the primitive up as a nonindexed primitive, using the indicated vertex range.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ setShadeModel()

setShadeModel ( GeomEnums::ShadeModel  shade_model)

Changes the ShadeModel hint for this primitive.

This is different from the ShadeModelAttrib that might also be applied from the scene graph. This does not affect the shade model that is in effect when rendering, but rather serves as a hint to the renderer to tell it how the per-vertex colors and normals on this primitive are applied.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ setUsageHint()

setUsageHint ( GeomEnums::UsageHint  usage_hint)

Changes the UsageHint hint for this primitive.

See get_usage_hint().

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ setVertices()

setVertices ( const GeomVertexArrayData  vertices,
int  num_vertices 
)

Completely replaces the vertex index list with a new table.

Chances are good that you should also replace the ends list with set_ends() at the same time.

If num_vertices is not -1, it specifies an artificial limit to the number of vertices in the array. Otherwise, all of the vertices in the array will be used.

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ data_size_bytes

int data_size_bytes

Returns the number of bytes stored in the vertices array.

◆ geom_rendering

int geom_rendering

Returns the set of GeomRendering bits that represent the rendering properties required to properly render this primitive.

◆ index_stride

int index_stride

A convenience function to return the gap between successive index numbers, in bytes, of the index data.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ index_type

Returns the numeric type of the index column.

Normally, this will be either NT_uint16 or NT_uint32.

◆ maxs

ConstPointerToGeomVertexArrayData maxs

Returns a const pointer to the primitive maxs array so application code can read it directly.

Do not attempt to modify the returned array; use set_minmax().

Note that simple primitive types, like triangles, do not have a maxs array.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ min_num_vertices_per_primitive

int min_num_vertices_per_primitive

Returns the minimum number of vertices that must be added before close_primitive() may legally be called.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ mins

ConstPointerToGeomVertexArrayData mins

Returns a const pointer to the primitive mins array so application code can read it directly.

Do not attempt to modify the returned array; use set_minmax() for this.

Note that simple primitive types, like triangles, do not have a mins array.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ modified

UpdateSeq modified

Returns a sequence number which is guaranteed to change at least every time the vertex index array is modified.

◆ num_bytes

int num_bytes

Returns the number of bytes consumed by the primitive and its index table(s).

◆ num_unused_vertices_per_primitive

int num_unused_vertices_per_primitive

Returns the number of vertices that are added between primitives that aren't, strictly speaking, part of the primitives themselves.

This is used, for instance, to define degenerate triangles to connect otherwise disconnected triangle strips.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ num_vertices_per_primitive

int num_vertices_per_primitive

If the primitive type is a simple type in which all primitives have the same number of vertices, like triangles, returns the number of vertices per primitive.

If the primitive type is a more complex type in which different primitives might have different numbers of vertices, for instance a triangle strip, returns 0.

This method is intended for low-level usage only. There are higher-level methods for more common usage. We recommend you do not use this method directly. If you do, be sure you know what you are doing!

◆ primitive_type

GeomEnums::PrimitiveType primitive_type

◆ shade_model

GeomEnums::ShadeModel shade_model

Returns the ShadeModel hint for this primitive.

This is intended as a hint to the renderer to tell it how the per-vertex colors and normals are applied.

◆ strip_cut_index

int strip_cut_index

If relevant, returns the index value that may be used in some cases to signify the end of a primitive.

This is typically the highest value that the numeric type can store.Returns the index of the indicated type that is reserved for use as a strip cut index, if enabled for the primitive. When the renderer encounters this index, it will restart the primitive. This is guaranteed not to point to an actual vertex.

◆ usage_hint

Returns the usage hint for this primitive.

See geomEnums.h. This has nothing to do with the usage hint associated with the primitive's vertices; this only specifies how often the vertex indices that define the primitive will be modified.

It is perfectly legal (and, in fact, common) for a GeomPrimitive to have UH_static on itself, while referencing vertex data with UH_dynamic. This means that the vertices themselves will be animated, but the primitive will always reference the same set of vertices from the pool.