This object provides a high-level interface for quickly reading a sequence of numeric values from a vertex table. More...

#include "geomVertexReader.h"

Inheritance diagram for GeomVertexReader:

List of all members.

Public Member Functions
	GeomVertexReader (Thread *current_thread=Thread::get_current_thread())
	Constructs an invalid GeomVertexReader.
	GeomVertexReader (const GeomVertexData vertex_data, Thread current_thread=Thread::get_current_thread())
	Constructs a new reader to process the vertices of the indicated data object.
	GeomVertexReader (const GeomVertexData vertex_data, const InternalName name, Thread *current_thread=Thread::get_current_thread())
	Constructs a new reader to process the vertices of the indicated data object.
	GeomVertexReader (const GeomVertexReader &copy)
	GeomVertexReader (const GeomVertexArrayData array_data, Thread current_thread=Thread::get_current_thread())
	Constructs a new reader to process the vertices of the indicated array only.
	GeomVertexReader (const GeomVertexData vertex_data, const string &name, Thread current_thread=Thread::get_current_thread())
	Constructs a new reader to process the vertices of the indicated data object.
	GeomVertexReader (const GeomVertexArrayData array_data, int column, Thread current_thread=Thread::get_current_thread())
	Constructs a new reader to process the vertices of the indicated array only.
	GeomVertexReader (const GeomVertexDataPipelineReader data_reader, const InternalName name, bool force=true)
	Constructs a new reader to process the vertices of the indicated data object.
void	clear ()
	Resets the GeomVertexReader to the initial state.
int	get_array () const
	Returns the array index containing the data type that the reader is working on.
const GeomVertexArrayData *	get_array_data () const
	Returns the particular array object that the reader is currently processing.
const GeomVertexArrayDataHandle *	get_array_handle () const
	Returns the read handle to the array object that the read is currently processing.
const GeomVertexColumn *	get_column () const
	Returns the description of the data type that the reader is working on.
Thread *	get_current_thread () const
	Returns the Thread pointer of the currently-executing thread, as passed to the constructor of this object.
PN_stdfloat	get_data1 ()
	Returns the data associated with the read row, expressed as a 1-component value, and advances the read row.
double	get_data1d ()
	Returns the data associated with the read row, expressed as a 1-component value, and advances the read row.
float	get_data1f ()
	Returns the data associated with the read row, expressed as a 1-component value, and advances the read row.
int	get_data1i ()
	Returns the data associated with the read row, expressed as a 1-component value, and advances the read row.
const LVecBase2 &	get_data2 ()
	Returns the data associated with the read row, expressed as a 2-component value, and advances the read row.
const LVecBase2d &	get_data2d ()
	Returns the data associated with the read row, expressed as a 2-component value, and advances the read row.
const LVecBase2f &	get_data2f ()
	Returns the data associated with the read row, expressed as a 2-component value, and advances the read row.
const int *	get_data2i ()
	Returns the data associated with the read row, expressed as a 2-component value, and advances the read row.
const LVecBase3 &	get_data3 ()
	Returns the data associated with the read row, expressed as a 3-component value, and advances the read row.
const LVecBase3d &	get_data3d ()
	Returns the data associated with the read row, expressed as a 3-component value, and advances the read row.
const LVecBase3f &	get_data3f ()
	Returns the data associated with the read row, expressed as a 3-component value, and advances the read row.
const int *	get_data3i ()
	Returns the data associated with the read row, expressed as a 3-component value, and advances the read row.
const LVecBase4 &	get_data4 ()
	Returns the data associated with the read row, expressed as a 4-component value, and advances the read row.
const LVecBase4d &	get_data4d ()
	Returns the data associated with the read row, expressed as a 4-component value, and advances the read row.
const LVecBase4f &	get_data4f ()
	Returns the data associated with the read row, expressed as a 4-component value, and advances the read row.
const int *	get_data4i ()
	Returns the data associated with the read row, expressed as a 4-component value, and advances the read row.
bool	get_force () const
	Returns the value of the force flag.
int	get_read_row () const
	Returns the row index from which the data will be retrieved by the next call to get_data*().
int	get_start_row () const
	Returns the row index at which the reader started.
size_t	get_stride () const
	Returns the per-row stride (bytes between consecutive rows) of the underlying vertex array.
const GeomVertexData *	get_vertex_data () const
	Returns the vertex data object that the reader is processing.
bool	has_column () const
	Returns true if a valid data type has been successfully set, or false if the data type does not exist (or if get_force() is false and the vertex data is nonresident).
bool	is_at_end () const
	Returns true if the reader is currently at the end of the list of vertices, false otherwise.
void	operator= (const GeomVertexReader &copy)
void	output (ostream &out) const
bool	set_column (int array, const GeomVertexColumn *column)
	Sets up the reader to use the indicated column description on the given array.
bool	set_column (const string &name)
	Sets up the reader to use the data type with the indicated name.
bool	set_column (const InternalName *name)
	Sets up the reader to use the data type with the indicated name.
bool	set_column (int column)
	Sets up the reader to use the nth data type of the GeomVertexFormat, numbering from 0.
void	set_force (bool force)
	Sets the value of the force flag.
void	set_row (int row)
	Sets the start row to the indicated value.
void	set_row_unsafe (int row)
	Sets the start row to the indicated value, without internal checks.
Protected Member Functions
GeomVertexColumn::Packer *	get_packer () const
	Returns the reader's Packer object.

Detailed Description

This object provides a high-level interface for quickly reading a sequence of numeric values from a vertex table.

It is particularly optimized for reading a single column of data values for a series of vertices, without changing columns between each number. Although you can also use one GeomVertexReader to read across the columns if it is convenient, by calling set_column() repeatedly at each vertex, it is faster to read down the columns, and to use a different GeomVertexReader for each column.

Note that a GeomVertexReader does not keep a reference count to the actual vertex data buffer (it grabs the current data buffer from the GeomVertexData whenever set_column() is called). This means that it is important not to keep a GeomVertexReader object around over a long period of time in which the data buffer is likely to be deallocated; it is intended for making a quick pass over the data in one session.

It also means that you should create any GeomVertexWriters *before* creating GeomVertexReaders on the same data, since the writer itself might cause the vertex buffer to be deallocated. Better yet, use a GeomVertexRewriter if you are going to create both of them anyway.

Definition at line 56 of file geomVertexReader.h.

Constructor & Destructor Documentation

GeomVertexReader::GeomVertexReader ( Thread * current_thread = Thread::get_current_thread() ) [inline]

Constructs an invalid GeomVertexReader.

You must use the assignment operator to assign a valid GeomVertexReader to this object before you can use it.

Definition at line 25 of file geomVertexReader.I.

Referenced by clear().

GeomVertexReader::GeomVertexReader	(	const GeomVertexData *	vertex_data,
		Thread *	current_thread = `Thread::get_current_thread()`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated data object.

Definition at line 39 of file geomVertexReader.I.

GeomVertexReader::GeomVertexReader	(	const GeomVertexData *	vertex_data,
		const string &	name,
		Thread *	current_thread = `Thread::get_current_thread()`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated data object.

This flavor creates the reader specifically to process the named data type.

Definition at line 55 of file geomVertexReader.I.

References set_column().

GeomVertexReader::GeomVertexReader	(	const GeomVertexData *	vertex_data,
		const InternalName *	name,
		Thread *	current_thread = `Thread::get_current_thread()`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated data object.

This flavor creates the reader specifically to process the named data type.

Definition at line 72 of file geomVertexReader.I.

References set_column().

GeomVertexReader::GeomVertexReader	(	const GeomVertexArrayData *	array_data,
		Thread *	current_thread = `Thread::get_current_thread()`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated array only.

Definition at line 89 of file geomVertexReader.I.

GeomVertexReader::GeomVertexReader	(	const GeomVertexArrayData *	array_data,
		int	column,
		Thread *	current_thread = `Thread::get_current_thread()`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated array only.

Definition at line 104 of file geomVertexReader.I.

References set_column().

GeomVertexReader::GeomVertexReader	(	const GeomVertexDataPipelineReader *	data_reader,
		const InternalName *	name,
		bool	force = `true`
	)		`[inline]`

Constructs a new reader to process the vertices of the indicated data object.

This flavor creates the reader specifically to process the named data type.

Definition at line 121 of file geomVertexReader.I.

References GeomVertexFormat::get_array_with(), and GeomVertexFormat::get_column().

Member Function Documentation

void GeomVertexReader::clear ( ) [inline]

Resets the GeomVertexReader to the initial state.

GeomVertexReader Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation