Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends

GeomVertexArrayDataHandle Class Reference

This data object is returned by GeomVertexArrayData::get_handle() or modify_handle(). More...

#include "geomVertexArrayData.h"

Inheritance diagram for GeomVertexArrayDataHandle:
ReferenceCount GeomEnums MemoryBase

List of all members.

Public Types

enum  AnimationType { AT_none, AT_panda, AT_hardware }
enum  Contents {
  C_other, C_point, C_clip_point, C_vector,
  C_texcoord, C_color, C_index, C_morph_delta
}
enum  GeomRendering {
  GR_indexed_point = 0x00001, GR_indexed_other = 0x10000, GR_indexed_bits = 0x10001, GR_point = 0x00002,
  GR_point_uniform_size = 0x00004, GR_per_point_size = 0x00008, GR_point_perspective = 0x00010, GR_point_aspect_ratio = 0x00020,
  GR_point_scale = 0x00040, GR_point_rotate = 0x00080, GR_point_sprite = 0x00100, GR_point_sprite_tex_matrix = 0x00200,
  GR_point_bits = 0x003fe, GR_triangle_strip = 0x00400, GR_triangle_fan = 0x00800, GR_line_strip = 0x01000,
  GR_composite_bits = 0x01c00, GR_flat_first_vertex = 0x02000, GR_flat_last_vertex = 0x04000, GR_shade_model_bits = 0x06000,
  GR_texcoord_light_vector = 0x08000
}
enum  NumericType {
  NT_uint8, NT_uint16, NT_uint32, NT_packed_dcba,
  NT_packed_dabc, NT_float32
}
enum  PrimitiveType { PT_none, PT_polygons, PT_lines, PT_points }
enum  ShadeModel { SM_uniform, SM_smooth, SM_flat_first_vertex, SM_flat_last_vertex }
enum  UsageHint {
  UH_client, UH_stream, UH_dynamic, UH_static,
  UH_unspecified
}

Public Member Functions

 ALLOC_DELETED_CHAIN_DECL (GeomVertexArrayDataHandle)
void clear_rows ()
void copy_data_from (const GeomVertexArrayDataHandle *other)
 Copies the entire data array from the other object.
void copy_subdata_from (size_t to_start, size_t to_size, const GeomVertexArrayDataHandle *other, size_t from_start, size_t from_size)
 Copies a portion of the data array from the other object into a portion of the data array of this object.
const GeomVertexArrayFormatget_array_format () const
Threadget_current_thread () const
string get_data () const
 Returns the entire raw data of the GeomVertexArrayData object, formatted as a string.
int get_data_size_bytes () const
UpdateSeq get_modified () const
int get_num_rows () const
const GeomVertexArrayDataget_object () const
GeomVertexArrayDataget_object ()
const unsigned char * get_read_pointer (bool force) const
 Returns a readable pointer to the beginning of the actual data stream, or NULL if the data is not currently resident.
int get_ref_count () const
 Returns the current reference count.
string get_subdata (size_t start, size_t size) const
 Returns a subset of the raw data of the GeomVertexArrayData object, formatted as a string.
UsageHint get_usage_hint () const
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
unsigned char * get_write_pointer ()
 Returns a writable pointer to the beginning of the actual data stream.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void mark_used () const
 Marks the array data recently-used.
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void ref () const
 Explicitly increments the reference count.
bool request_resident () const
 Returns true if the vertex data is currently resident in memory.
void set_data (const string &data)
 Replaces the entire raw data array with the contents of the indicated string.
bool set_num_rows (int n)
void set_subdata (size_t start, size_t size, const string &data)
 Replaces a portion of the data array from the indicated string.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unclean_set_num_rows (int n)
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Protected Member Functions

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.

Friends

class GeomVertexArrayData

Detailed Description

This data object is returned by GeomVertexArrayData::get_handle() or modify_handle().

As long as it exists, the data is locked; when the last of these destructs, the data is unlocked.

Only one thread at a time may lock the data; other threads attempting to lock the data will block. A given thread may simultaneously lock the data multiple times.

This class serves in lieu of a pair of GeomVertexArrayDataPipelineReader and GeomVertexArrayDataPipelineWriter classes

Definition at line 247 of file geomVertexArrayData.h.


Member Function Documentation

void GeomVertexArrayDataHandle::copy_data_from ( const GeomVertexArrayDataHandle other)

Copies the entire data array from the other object.

Definition at line 771 of file geomVertexArrayData.cxx.

References Geom::get_next_modified(), and mark_used().

void GeomVertexArrayDataHandle::copy_subdata_from ( size_t  to_start,
size_t  to_size,
const GeomVertexArrayDataHandle other,
size_t  from_start,
size_t  from_size 
)

Copies a portion of the data array from the other object into a portion of the data array of this object.

If to_size != from_size, the size of this data array is adjusted accordingly.

Definition at line 799 of file geomVertexArrayData.cxx.

References VertexDataBuffer::clean_realloc(), Geom::get_next_modified(), get_read_pointer(), VertexDataBuffer::get_size(), VertexDataBuffer::get_write_pointer(), and mark_used().

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

string GeomVertexArrayDataHandle::get_data ( ) const [inline]

Returns the entire raw data of the GeomVertexArrayData object, formatted as a string.

This is primarily for the benefit of high-level languages such as Python.

Definition at line 489 of file geomVertexArrayData.I.

References mark_used().

const unsigned char * GeomVertexArrayDataHandle::get_read_pointer ( bool  force) const [inline]

Returns a readable pointer to the beginning of the actual data stream, or NULL if the data is not currently resident.

If the data is not currently resident, this will implicitly request it to become resident soon.

If force is true, this method will never return NULL, but may block until the data is available.

Definition at line 381 of file geomVertexArrayData.I.

References mark_used().

Referenced by copy_subdata_from(), DXGraphicsStateGuardian9::draw_lines(), DXGraphicsStateGuardian8::draw_lines(), DXGraphicsStateGuardian9::draw_points(), DXGraphicsStateGuardian8::draw_points(), DXGraphicsStateGuardian9::draw_triangles(), DXGraphicsStateGuardian8::draw_triangles(), DXGraphicsStateGuardian9::draw_trifans(), DXGraphicsStateGuardian8::draw_trifans(), DXGraphicsStateGuardian9::draw_tristrips(), DXGraphicsStateGuardian8::draw_tristrips(), request_resident(), DXVertexBufferContext9::upload_data(), and DXVertexBufferContext8::upload_data().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
string GeomVertexArrayDataHandle::get_subdata ( size_t  start,
size_t  size 
) const [inline]

Returns a subset of the raw data of the GeomVertexArrayData object, formatted as a string.

This is primarily for the benefit of high-level languages such as Python.

Definition at line 503 of file geomVertexArrayData.I.

References mark_used().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

unsigned char * GeomVertexArrayDataHandle::get_write_pointer ( )

Returns a writable pointer to the beginning of the actual data stream.

Definition at line 694 of file geomVertexArrayData.cxx.

References Geom::get_next_modified().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void GeomVertexArrayDataHandle::mark_used ( ) const [inline]

Marks the array data recently-used.

Definition at line 516 of file geomVertexArrayData.I.

Referenced by copy_data_from(), copy_subdata_from(), get_data(), get_read_pointer(), get_subdata(), set_data(), and set_subdata().

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

bool GeomVertexArrayDataHandle::request_resident ( ) const [inline]

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

If this returns true, the next call to get_handle()->get_read_pointer() will probably not block. If this returns false, the vertex data will be brought back into memory shortly; try again later.

Definition at line 476 of file geomVertexArrayData.I.

References get_read_pointer().

void GeomVertexArrayDataHandle::set_data ( const string &  data)

Replaces the entire raw data array with the contents of the indicated string.

This is primarily for the benefit of high-level languages like Python.

Definition at line 852 of file geomVertexArrayData.cxx.

References Geom::get_next_modified(), and mark_used().

void GeomVertexArrayDataHandle::set_subdata ( size_t  start,
size_t  size,
const string &  data 
)

Replaces a portion of the data array from the indicated string.

If size != data.size(), the size of this data array is adjusted accordingly.

This is primarily for the benefit of high-level languages like Python.

Definition at line 877 of file geomVertexArrayData.cxx.

References VertexDataBuffer::clean_realloc(), Geom::get_next_modified(), VertexDataBuffer::get_size(), VertexDataBuffer::get_write_pointer(), and mark_used().

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations