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

Specifies how polygons are to be drawn. More...

Inheritance diagram for RenderModeAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Mode {
  M_unchanged = 0, M_filled = 1, M_wireframe = 2, M_point = 3,
  M_filled_flat = 4, M_filled_wireframe = 5
}
 
- Public Types inherited from RenderAttrib
enum  PandaCompareFunc {
  M_none = 0, M_never = 1, M_less = 2, M_equal = 3,
  M_less_equal = 4, M_greater = 5, M_not_equal = 6, M_greater_equal = 7,
  M_always = 8
}
 
enum  TexGenMode {
  M_off = 0, M_eye_sphere_map = 1, M_world_cube_map = 2, M_eye_cube_map = 3,
  M_world_normal = 4, M_eye_normal = 5, M_world_position = 6, M_unused = 7,
  M_eye_position = 8, M_point_sprite = 9, M_unused2 = 10, M_constant = 11
}
 

Public Member Functions

int getGeomRendering (int geom_rendering)
 Returns the union of the Geom::GeomRendering bits that will be required once this RenderModeAttrib is applied to a geom which includes the indicated geom_rendering bits. More...
 
RenderModeAttrib::Mode getMode ()
 Returns the render mode. More...
 
bool getPerspective ()
 Returns the perspective flag. More...
 
float getThickness ()
 Returns the line width or point thickness. More...
 
const LColor getWireframeColor ()
 Returns the color that is used in M_filled_wireframe mode to distinguish the wireframe from the rest of the geometry. More...
 
- Public Member Functions inherited from RenderAttrib
int compareTo (const RenderAttrib other)
 Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. More...
 
const RenderAttrib compose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of this attrib with the other attrib. More...
 
int getHash ()
 Returns a suitable hash value for phash_map. More...
 
int getSlot ()
 
const RenderAttrib getUnique ()
 Returns the pointer to the unique RenderAttrib in the cache that is equivalent to this one. More...
 
const RenderAttrib invertCompose (const RenderAttrib other)
 Returns a new RenderAttrib object that represents the composition of the inverse of this attrib with the other attrib. More...
 
bool lowerAttribCanOverride ()
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- 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...
 

Static Public Member Functions

static int getClassSlot ()
 
static TypeHandle getClassType ()
 
static const RenderAttrib make (RenderModeAttrib::Mode mode, float thickness, bool perspective, const LColor wireframe_color)
 Constructs a new RenderModeAttrib object that specifies whether to draw polygons in the normal, filled mode, or wireframe mode, or in some other yet-to-be-defined mode. More...
 
static const RenderAttrib makeDefault ()
 Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be. More...
 
- Static Public Member Functions inherited from RenderAttrib
static int garbageCollect ()
 Performs a garbage-collection cycle. More...
 
static TypeHandle getClassType ()
 
static int getNumAttribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world. More...
 
static listAttribs (Ostream out)
 Lists all of the RenderAttribs in the cache to the output stream, one per line. More...
 
static bool validateAttribs ()
 Ensures that the cache is still stored in sorted order. More...
 
- 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 class_slot
 
RenderModeAttrib::Mode mode
 Returns the render mode. More...
 
bool perspective
 Returns the perspective flag. More...
 
float thickness
 Returns the line width or point thickness. More...
 
const LColor wireframe_color
 Returns the color that is used in M_filled_wireframe mode to distinguish the wireframe from the rest of the geometry. More...
 
- Public Attributes inherited from RenderAttrib
int slot
 
- 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...
 

Detailed Description

Specifies how polygons are to be drawn.

Member Enumeration Documentation

◆ Mode

enum Mode
Enumerator
M_unchanged 
M_filled 

Normal, filled polygons.

M_wireframe 

Wireframe polygons, possibly with thickness.

M_point 

Points at vertices only, possibly with thickness andor perspective sizing.

M_filled_flat 

Filled polygons, without any particular emphasis on perspective correctness (a particularly useful designation for software rendering sprites).

M_filled_wireframe 

Filled polygons with wireframe rendered in front. The wireframe is given a solid color.

Member Function Documentation

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getGeomRendering()

int getGeomRendering ( int  geom_rendering)

Returns the union of the Geom::GeomRendering bits that will be required once this RenderModeAttrib is applied to a geom which includes the indicated geom_rendering bits.

◆ getMode()

Returns the render mode.

◆ getPerspective()

bool getPerspective ( )

Returns the perspective flag.

When this is true, the point thickness represented by get_thickness() is actually a width in 3-d units, and the points should scale according to perspective. When it is false, the default, the point thickness is actually a width in pixels, and points are a uniform size regardless of distance from the camera.

◆ getThickness()

float getThickness ( )

Returns the line width or point thickness.

This is only relevant when rendering points or lines, such as when the mode is M_wireframe or M_point (or when rendering actual points or lines primitives in M_polygon mode).

◆ getWireframeColor()

const LColor getWireframeColor ( )

Returns the color that is used in M_filled_wireframe mode to distinguish the wireframe from the rest of the geometry.

◆ make()

static const RenderAttrib make ( RenderModeAttrib::Mode  mode,
float  thickness,
bool  perspective,
const LColor  wireframe_color 
)
static

Constructs a new RenderModeAttrib object that specifies whether to draw polygons in the normal, filled mode, or wireframe mode, or in some other yet-to-be-defined mode.

The thickness parameter specifies the thickness to be used for wireframe lines, as well as for ordinary linestrip lines; it also specifies the diameter of points. (Thick lines are presently only supported in OpenGL; but thick points are supported on either platform.)

If perspective is true, the point thickness represented is actually a width in 3-d units, and the points should scale according to perspective. When it is false, the point thickness is actually a width in pixels, and points are a uniform screen size regardless of distance from the camera.

In M_filled_wireframe mode, you should also specify the wireframe_color, indicating the flat color to assign to the overlayed wireframe.

◆ makeDefault()

static const RenderAttrib makeDefault ( )
static

Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

Member Data Documentation

◆ class_slot

int class_slot

◆ mode

Returns the render mode.

◆ perspective

bool perspective

Returns the perspective flag.

When this is true, the point thickness represented by get_thickness() is actually a width in 3-d units, and the points should scale according to perspective. When it is false, the default, the point thickness is actually a width in pixels, and points are a uniform size regardless of distance from the camera.

◆ thickness

float thickness

Returns the line width or point thickness.

This is only relevant when rendering points or lines, such as when the mode is M_wireframe or M_point (or when rendering actual points or lines primitives in M_polygon mode).

◆ wireframe_color

const LColor wireframe_color

Returns the color that is used in M_filled_wireframe mode to distinguish the wireframe from the rest of the geometry.