Panda3D
Classes | Public Member Functions
LineSegs Class Reference

Encapsulates creation of a series of connected or disconnected line segments or points, for drawing paths or rays. More...

#include "lineSegs.h"

Inheritance diagram for LineSegs:
Namable MemoryBase

List of all members.

Classes

class  Point

Public Member Functions

 LineSegs (const string &name="lines")
 Constructs a LineSegs object, which can be used to create any number of disconnected lines or points of various thicknesses and colors through the visible scene.
GeomNodecreate (bool dynamic=false)
 Creates a new GeomNode that will render the series of line segments and points described via calls to move_to() and draw_to().
GeomNodecreate (GeomNode *previous, bool dynamic=false)
 Appends to an existing GeomNode a new Geom that will render the series of line segments and points described via calls to move_to() and draw_to().
void draw_to (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 Draws a line segment from the pen's last position (the last call to move_to or draw_to) to the indicated point.
void draw_to (const LVecBase3 &v)
 Draws a line segment from the pen's last position (the last call to move_to or draw_to) to the indicated point.
const LVertexget_current_position ()
 Returns the pen's current position.
int get_num_vertices () const
 Returns the total number of line segment and point vertices generated by the last call to create().
LVertex get_vertex (int n) const
 Returns the nth point or vertex of the line segment sequence generated by the last call to create().
LColor get_vertex_color (int vertex) const
 Returns the color of the nth point or vertex.
bool is_empty ()
 Returns true if move_to() or draw_to() have not been called since the last reset() or create(), false otherwise.
 MAKE_SEQ (get_vertices, get_num_vertices, get_vertex)
 MAKE_SEQ (get_vertex_colors, get_num_vertices, get_vertex_color)
void move_to (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 Moves the pen to the given point without drawing a line.
void move_to (const LVecBase3 &v)
 Moves the pen to the given point without drawing a line.
void reset ()
 Removes any lines in progress and resets to the initial empty state.
void set_color (PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a=1.0f)
 Establishes the color that will be assigned to all vertices created by future calls to move_to() and draw_to().
void set_color (const LColor &color)
 Establishes the color that will be assigned to all vertices created by future calls to move_to() and draw_to().
void set_thickness (PN_stdfloat thick)
 Establishes the line thickness or point size in pixels that will be assigned to all lines and points created by future calls to create().
void set_vertex (int n, const LVertex &vert)
 Moves the nth point or vertex of the line segment sequence generated by the last call to create().
void set_vertex (int vertex, PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 Moves the nth point or vertex of the line segment sequence generated by the last call to create().
void set_vertex_color (int vertex, const LColor &c)
 Changes the vertex color of the nth point or vertex.
void set_vertex_color (int vertex, PN_stdfloat r, PN_stdfloat g, PN_stdfloat b, PN_stdfloat a=1.0f)
 Changes the vertex color of the nth point or vertex.

Detailed Description

Encapsulates creation of a series of connected or disconnected line segments or points, for drawing paths or rays.

This class doesn't attempt to be the smartest it could possibly be; it's intended primarily as a visualization and editing tool.

Definition at line 36 of file lineSegs.h.


Constructor & Destructor Documentation

LineSegs::LineSegs ( const string &  name = "lines")

Constructs a LineSegs object, which can be used to create any number of disconnected lines or points of various thicknesses and colors through the visible scene.

After creating the object, call move_to() and draw_to() repeatedly to describe the path, then call create() to create a GeomNode which will render the described path.

Definition at line 36 of file lineSegs.cxx.


Member Function Documentation

GeomNode * LineSegs::create ( bool  dynamic = false) [inline]

Creates a new GeomNode that will render the series of line segments and points described via calls to move_to() and draw_to().

The lines and points are created with the color and thickness established by calls to set_color() and set_thick().

If dynamic is true, the line segments will be created with the dynamic Geom setting, optimizing them for runtime vertex animation.

Definition at line 137 of file lineSegs.I.

Referenced by PGEntry::setup_minimal(), and PathFind::trace_path().

GeomNode * LineSegs::create ( GeomNode previous,
bool  dynamic = false 
)

Appends to an existing GeomNode a new Geom that will render the series of line segments and points described via calls to move_to() and draw_to().

The lines and points are created with the color and thickness established by calls to set_color() and set_thick().

If dynamic is true, the line segments will be created with the dynamic Geom setting, optimizing them for runtime vertex animation.

Definition at line 210 of file lineSegs.cxx.

References GeomVertexWriter::add_data3(), GeomVertexWriter::add_data4(), GeomNode::add_geom(), GeomVertexFormat::get_v3cp(), and reset().

void LineSegs::draw_to ( PN_stdfloat  x,
PN_stdfloat  y,
PN_stdfloat  z 
) [inline]

Draws a line segment from the pen's last position (the last call to move_to or draw_to) to the indicated point.

move_to() and draw_to() only update tables; the actual drawing is performed when create() is called.

Definition at line 119 of file lineSegs.I.

Referenced by PGEntry::setup_minimal(), and PathFind::trace_path().

void LineSegs::draw_to ( const LVecBase3 v)

Draws a line segment from the pen's last position (the last call to move_to or draw_to) to the indicated point.

move_to() and draw_to() only update tables; the actual drawing is performed when create() is called.

Definition at line 91 of file lineSegs.cxx.

References move_to().

Returns the pen's current position.

The next call to draw_to() will draw a line segment from this point.

Definition at line 186 of file lineSegs.cxx.

References move_to().

int LineSegs::get_num_vertices ( ) const [inline]

Returns the total number of line segment and point vertices generated by the last call to create().

The positions of these vertices may be read and adjusted through get_vertex() and set_vertex().

Definition at line 151 of file lineSegs.I.

LVertex LineSegs::get_vertex ( int  n) const

Returns the nth point or vertex of the line segment sequence generated by the last call to create().

The first move_to() generates vertex 0; subsequent move_to() and draw_to() calls generate consecutively higher vertex numbers.

Definition at line 128 of file lineSegs.cxx.

References GeomVertexReader::get_data3(), GeomVertexReader::set_row_unsafe(), and LPoint3f::zero().

LColor LineSegs::get_vertex_color ( int  vertex) const

Returns the color of the nth point or vertex.

Definition at line 158 of file lineSegs.cxx.

References GeomVertexReader::get_data4(), GeomVertexReader::set_row_unsafe(), and LVecBase4f::zero().

Returns true if move_to() or draw_to() have not been called since the last reset() or create(), false otherwise.

Definition at line 114 of file lineSegs.cxx.

void LineSegs::move_to ( PN_stdfloat  x,
PN_stdfloat  y,
PN_stdfloat  z 
) [inline]

Moves the pen to the given point without drawing a line.

When followed by draw_to(), this marks the first point of a line segment; when followed by move_to() or create(), this creates a single point.

Definition at line 105 of file lineSegs.I.

Referenced by draw_to(), get_current_position(), PGEntry::setup_minimal(), and PathFind::trace_path().

void LineSegs::move_to ( const LVecBase3 v)

Moves the pen to the given point without drawing a line.

When followed by draw_to(), this marks the first point of a line segment; when followed by move_to() or create(), this creates a single point.

Definition at line 72 of file lineSegs.cxx.

void LineSegs::reset ( )

Removes any lines in progress and resets to the initial empty state.

Definition at line 58 of file lineSegs.cxx.

Referenced by create().

void LineSegs::set_color ( PN_stdfloat  r,
PN_stdfloat  g,
PN_stdfloat  b,
PN_stdfloat  a = 1.0f 
) [inline]

Establishes the color that will be assigned to all vertices created by future calls to move_to() and draw_to().

Definition at line 68 of file lineSegs.I.

Referenced by PGEntry::setup_minimal().

void LineSegs::set_color ( const LColor color) [inline]

Establishes the color that will be assigned to all vertices created by future calls to move_to() and draw_to().

Definition at line 80 of file lineSegs.I.

void LineSegs::set_thickness ( PN_stdfloat  thick) [inline]

Establishes the line thickness or point size in pixels that will be assigned to all lines and points created by future calls to create().

Definition at line 92 of file lineSegs.I.

void LineSegs::set_vertex ( int  n,
const LVertex vert 
)

Moves the nth point or vertex of the line segment sequence generated by the last call to create().

The first move_to() generates vertex 0; subsequent move_to() and draw_to() calls generate consecutively higher vertex numbers.

Definition at line 145 of file lineSegs.cxx.

References GeomVertexWriter::set_data3(), and GeomVertexWriter::set_row_unsafe().

Referenced by set_vertex().

void LineSegs::set_vertex ( int  n,
PN_stdfloat  x,
PN_stdfloat  y,
PN_stdfloat  z 
) [inline]

Moves the nth point or vertex of the line segment sequence generated by the last call to create().

The first move_to() generates vertex 0; subsequent move_to() and draw_to() calls generate consecutively higher vertex numbers.

Definition at line 168 of file lineSegs.I.

References set_vertex().

void LineSegs::set_vertex_color ( int  n,
const LColor c 
)

Changes the vertex color of the nth point or vertex.

See set_vertex().

Definition at line 172 of file lineSegs.cxx.

References GeomVertexWriter::set_data4(), and GeomVertexWriter::set_row_unsafe().

Referenced by set_vertex_color().

void LineSegs::set_vertex_color ( int  n,
PN_stdfloat  r,
PN_stdfloat  g,
PN_stdfloat  b,
PN_stdfloat  a = 1.0f 
) [inline]

Changes the vertex color of the nth point or vertex.

See set_vertex().

Definition at line 179 of file lineSegs.I.

References set_vertex_color().


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