Panda3D

Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
PointerToArray< Element > Class Template Reference

A special kind of PointerTo that stores an array of the indicated element type, instead of a single element. More...

`#include "pointerToArray.h"`

Inheritance diagram for PointerToArray< Element >:

## Public Types
typedef pvector< Element >::const_iterator | const_iterator
typedef pvector< Element >::const_reference | const_reference
typedef pvector< Element >::const_reverse_iterator | const_reverse_iterator
typedef pvector< Element >::difference_type | difference_type
typedef pvector< Element >::iterator | iterator
typedef pvector< Element >::reference | reference
typedef pvector< Element >::reverse_iterator | reverse_iterator
typedef pvector< Element >::size_type | size_type
typedef PointerToArrayBase< Element >::To | To
typedef pvector< Element >::value_type | value_type
Public Types inherited from PointerToArrayBase< Element >
typedef PointerToBase< ReferenceCountedVector< Element > >::To | To
Public Types inherited from PointerToBase< ReferenceCountedVector< Element > >
typedef ReferenceCountedVector< Element > | To

## Public Member Functions
| PointerToArray (const Element *begin, const Element *end, TypeHandle type_handle=get_type_handle(Element))
| Initializes a PointerToArray by copying existing elements. More...
| PointerToArray (const PointerToArray< Element > &copy)
| PointerToArray (PointerToArray< Element > &&from) noexcept
| PointerToArray (pvector< Element > &&from, TypeHandle type_handle=get_type_handle(Element))
| Initializes the PTA from a vector. More...
| PointerToArray (size_type n, const Element &value, TypeHandle type_handle=get_type_handle(Element))
| PointerToArray (TypeHandle type_handle=get_type_handle(Element))
reference | back () const
iterator | begin () const
size_type | capacity () const
void | clear ()
| To empty the PTA, use the clear() method, since assignment to NULL is problematic (given the ambiguity of the pointer type of NULL). More...
size_t | count (const Element &) const
| Counts the frequency at which the given element occurs in the vector. More...
bool | empty () const
iterator | end () const
void | erase (iterator first, iterator last)
void | erase (iterator position)
reference | front () const
std::string | get_data () const
| This method exists mainly to access the data of the array easily from a high-level language such as Python. More...
const Element & | get_element (size_type n) const
| This method exists mainly to access the elements of the array easily from a high-level language such as Python, especially on Windows, where the above index element accessor methods can't be defined because of a confusion with the pointer typecast operator. More...
int | get_node_ref_count () const
| Returns the node_ref of the underlying vector. More...
int | get_ref_count () const
| Returns the reference count of the underlying vector. More...
std::string | get_subdata (size_type n, size_type count) const
| This method exists mainly to access the data of the array easily from a high-level language such as Python. More...
void * | get_void_ptr () const
| Returns the reference to memory where the vector is stored. More...
iterator | insert (iterator position, const Element &x)
void | insert (iterator position, size_type n, const Element &x)
void | make_empty ()
| Empties the array pointed to. More...
size_type | max_size () const
void | node_ref () const
| Increments the node_ref of the underlying vector. More...
bool | node_unref () const
| Decrements the node_ref of the underlying vector. More...
| operator Element * () const
| The pointer typecast operator is convenient for maintaining the fiction that we actually have a C-style array. More...
PointerToArray< Element > & | operator= (const PointerToArray< Element > &copy)
PointerToArray< Element > & | operator= (PointerToArray< Element > &&from) noexcept
PointerToArray< Element > & | operator= (ReferenceCountedVector< Element > *ptr)
reference | operator[] (int n) const
reference | operator[] (size_type n) const
Element * | p () const
| Function p() is similar to the function from PointerTo. More...
void | pop_back ()
void | push_back (const Element &x)
PointerToArray< Element >::reverse_iterator | rbegin () const
void | ref () const
| Increments the reference count of the underlying vector. More...
PointerToArray< Element >::reverse_iterator | rend () const
void | reserve (size_type n)
void | resize (size_type n)
void | set_data (const std::string &data)
| This method exists mainly to access the data of the array easily from a high-level language such as Python. More...
void | set_element (size_type n, const Element &value)
| This method exists mainly to access the elements of the array easily from a high-level language such as Python, especially on Windows, where the above index element accessor methods can't be defined because of a confusion with the pointer typecast operator. More...
void | set_subdata (size_type n, size_type count, const std::string &data)
| This method exists mainly to access the data of the array easily from a high-level language such as Python. More...
void | set_void_ptr (void *p)
| Sets this PTA to point to the pointer passed in. More...
size_type | size () const
bool | unref () const
| Decrements the reference count of the underlying vector. More...
pvector< Element > & | v () const
| To access the vector itself, for more direct fiddling with some of the vector's esoteric functionality. More...
ReferenceCountedVector< Element > * | v0 () const
| To access the internal ReferenceCountedVector object, for very low-level fiddling. More...
Public Member Functions inherited from PointerToBase< ReferenceCountedVector< Element > >
void | clear ()
| A convenient way to set the PointerTo object to NULL. More...
void | output (std::ostream &out) const
| A handy function to output PointerTo's as a hex pointer followed by a reference count. More...
Public Member Functions inherited from PointerToVoid
size_t | get_hash () const
constexpr bool | is_null () const
| Returns true if the PointerTo is a NULL pointer, false otherwise. More...
bool | operator!= (const PointerToVoid &other) const
bool | operator< (const PointerToVoid &other) const
bool | operator< (const void *other) const
bool | operator== (const PointerToVoid &other) const
void | swap (PointerToVoid &other) noexcept
| Swaps the contents of this PointerTo with the other, without touching the reference counts. More...
Public Member Functions inherited from MemoryBase
void | operator delete (void *, 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 * | operator new[] (size_t size, void *ptr)

## Static Public Member Functions
static PointerToArray< Element > | empty_array (size_type n, TypeHandle type_handle=get_type_handle(Element))
| Return an empty array of size n. More...

## Friends
class | ConstPointerToArray< Element >

## Detailed Description

### template<class Element>
class PointerToArray< Element >

A special kind of PointerTo that stores an array of the indicated element type, instead of a single element.

This is actually implemented as an STL vector, using the RefCountObj class to wrap it up with a reference count.

We actually inherit from NodeRefCountObj these days, which adds node_ref() and node_unref() to the standard ref() and unref(). This is particularly useful for GeomVertexArrayData; other classes may or may not find this additional counter useful, but since it adds relatively little overhead (compared with what is presumably a largish array), we go ahead and add it here, even though it is inherited by many different parts of the system that may not use it.

Definition at line 87 of file pointerToArray.h.

## Constructor & Destructor Documentation

## ◆ PointerToArray() [1/2]

template<class Element >

PointerToArray< Element >::PointerToArray | ( | const Element * | begin,
|  | const Element * | end,
|  | TypeHandle | type_handle = `get_type_handle(Element)`
| ) |  |
| inline

Initializes a PointerToArray by copying existing elements.

Definition at line 75 of file pointerToArray.I.

## ◆ PointerToArray() [2/2]

template<class Element >

PointerToArray< Element >::PointerToArray | ( | pvector< Element > && | from,
|  | TypeHandle | type_handle = `get_type_handle(Element)`
| ) |  |
| inline explicit

Initializes the PTA from a vector.

Definition at line 97 of file pointerToArray.I.

## Member Function Documentation

## ◆ clear()

template<class Element >

void PointerToArray< Element >::clear
| inline

To empty the PTA, use the clear() method, since assignment to NULL is problematic (given the ambiguity of the pointer type of NULL).

Definition at line 643 of file pointerToArray.I.

## ◆ count()

template<class Element >

size_t PointerToArray< Element >::count | ( | const Element & | value | ) | const
| inline

Counts the frequency at which the given element occurs in the vector.

Definition at line 597 of file pointerToArray.I.

## ◆ empty_array()

template<class Element >

PointerToArray< Element > PointerToArray< Element >::empty_array | ( | size_type | n,
|  | TypeHandle | type_handle = `get_type_handle(Element)`
| ) |  |
| inline static

Return an empty array of size n.

Definition at line 38 of file pointerToArray.I.

## ◆ get_data()

template<class Element >

std::string PointerToArray< Element >::get_data
| inline

This method exists mainly to access the data of the array easily from a high-level language such as Python.

It returns the entire contents of the vector as a block of raw data in a string.

Definition at line 446 of file pointerToArray.I.

## ◆ get_element()

template<class Element >

const Element & PointerToArray< Element >::get_element | ( | size_type | n | ) | const
| inline

This method exists mainly to access the elements of the array easily from a high-level language such as Python, especially on Windows, where the above index element accessor methods can't be defined because of a confusion with the pointer typecast operator.

Definition at line 420 of file pointerToArray.I.

## ◆ get_node_ref_count()

template<class Element >

int PointerToArray< Element >::get_node_ref_count
| inline

Returns the node_ref of the underlying vector.

Definition at line 566 of file pointerToArray.I.

## ◆ get_ref_count()

template<class Element >

int PointerToArray< Element >::get_ref_count
| inline

Returns the reference count of the underlying vector.

Definition at line 535 of file pointerToArray.I.

## ◆ get_subdata()

template<class Element >

std::string PointerToArray< Element >::get_subdata | ( | size_type | n,
|  | size_type | count
| ) |  | const
| inline

This method exists mainly to access the data of the array easily from a high-level language such as Python.

It returns the contents of a portion of the vector–from element (n) through element (n + count - 1)–as a block of raw data in a string.

Definition at line 472 of file pointerToArray.I.

## ◆ get_void_ptr()

template<class Element >

void * PointerToArray< Element >::get_void_ptr
| inline

Returns the reference to memory where the vector is stored.

To be used only with set_void_ptr

Definition at line 517 of file pointerToArray.I.

## ◆ make_empty()

template<class Element >

void PointerToArray< Element >::make_empty
| inline

Empties the array pointed to.

This is different from clear(), which reassigns the pointer to a NULL pointer.

Definition at line 357 of file pointerToArray.I.

## ◆ node_ref()

template<class Element >

void PointerToArray< Element >::node_ref
| inline

Increments the node_ref of the underlying vector.

Definition at line 575 of file pointerToArray.I.

## ◆ node_unref()

template<class Element >

bool PointerToArray< Element >::node_unref
| inline

Decrements the node_ref of the underlying vector.

Definition at line 587 of file pointerToArray.I.

## ◆ operator Element *()

template<class Element >

PointerToArray< Element >::operator Element *
| inline

The pointer typecast operator is convenient for maintaining the fiction that we actually have a C-style array.

It returns the address of the first element in the array, unless the pointer is unassigned, in which case it returns NULL.

Definition at line 373 of file pointerToArray.I.

## ◆ p()

template<class Element >

Element * PointerToArray< Element >::p
| inline

Function p() is similar to the function from PointerTo.

It does the same thing: it returns the same thing as the typecast operator, above.

Definition at line 384 of file pointerToArray.I.

## ◆ ref()

template<class Element >

void PointerToArray< Element >::ref
| inline

Increments the reference count of the underlying vector.

Definition at line 544 of file pointerToArray.I.

## ◆ set_data()

template<class Element >

void PointerToArray< Element >::set_data | ( | const std::string & | data | ) |
| inline

This method exists mainly to access the data of the array easily from a high-level language such as Python.

It replaces the entire contents of the vector from a block of raw data in a string.

Definition at line 459 of file pointerToArray.I.

## ◆ set_element()

template<class Element >

void PointerToArray< Element >::set_element | ( | size_type | n,
|  | const Element & | value
| ) |  |
| inline

This method exists mainly to access the elements of the array easily from a high-level language such as Python, especially on Windows, where the above index element accessor methods can't be defined because of a confusion with the pointer typecast operator.

Definition at line 432 of file pointerToArray.I.

## ◆ set_subdata()

template<class Element >

void PointerToArray< Element >::set_subdata | ( | size_type | n,
|  | size_type | count,
|  | const std::string & | data
| ) |  |
| inline

This method exists mainly to access the data of the array easily from a high-level language such as Python.

It replaces the contents of a portion of the vector–from element (n) through element (n + count - 1)–as a block of raw data in a string. The length of the string must be an even multiple of Element size bytes. The array may be expanded or truncated if the length of the string does not correspond to exactly count elements.

Definition at line 491 of file pointerToArray.I.

## ◆ set_void_ptr()

template<class Element >

void PointerToArray< Element >::set_void_ptr | ( | void * | p | ) |
| inline

Sets this PTA to point to the pointer passed in.

Definition at line 526 of file pointerToArray.I.

## ◆ unref()

template<class Element >

bool PointerToArray< Element >::unref
| inline

Decrements the reference count of the underlying vector.

Definition at line 556 of file pointerToArray.I.

## ◆ v()

template<class Element >

pvector< Element > & PointerToArray< Element >::v
| inline

To access the vector itself, for more direct fiddling with some of the vector's esoteric functionality.

Definition at line 395 of file pointerToArray.I.

## ◆ v0()

template<class Element >

ReferenceCountedVector< Element > * PointerToArray< Element >::v0
| inline

To access the internal ReferenceCountedVector object, for very low-level fiddling.

Know what you are doing!

Definition at line 408 of file pointerToArray.I.

The documentation for this class was generated from the following files:

- panda/src/express/pointerToArray.h
- panda/src/express/pointerToArray.I