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

Indicates which faces should be culled based on their vertex ordering. More...

Inheritance diagram for CullFaceAttrib:
RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Mode { M_cull_none = 0, M_cull_clockwise = 1, M_cull_counter_clockwise = 2, M_cull_unchanged = 3 }
 
- 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

CullFaceAttrib::Mode getActualMode ()
 Returns the actual culling mode, without considering the effects of the reverse flag. More...
 
CullFaceAttrib::Mode getEffectiveMode ()
 Returns the effective culling mode. More...
 
bool getReverse ()
 Returns the 'reverse' flag. 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 (CullFaceAttrib::Mode mode)
 Constructs a new CullFaceAttrib object that specifies how to cull geometry. 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 const RenderAttrib makeReverse ()
 Constructs a new CullFaceAttrib object that reverses the effects of any other CullFaceAttrib objects in the scene graph. 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
 
CullFaceAttrib::Mode effective_mode
 Returns the effective culling mode. More...
 
CullFaceAttrib::Mode mode
 Returns the actual culling mode, without considering the effects of the reverse flag. More...
 
bool reverse
 Returns the 'reverse' flag. 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

Indicates which faces should be culled based on their vertex ordering.

Member Enumeration Documentation

◆ Mode

enum Mode
Enumerator
M_cull_none 

Cull no polygons.

M_cull_clockwise 

Cull clockwise-oriented polygons.

M_cull_counter_clockwise 

Cull counter-clockwise-oriented polygons.

M_cull_unchanged 

Do not change existing cull behavior.

Member Function Documentation

◆ getActualMode()

CullFaceAttrib::Mode getActualMode ( )

Returns the actual culling mode, without considering the effects of the reverse flag.

See also get_effective_mode().

◆ getClassSlot()

static int getClassSlot ( )
static

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getEffectiveMode()

CullFaceAttrib::Mode getEffectiveMode ( )

Returns the effective culling mode.

This is the same as the actual culling mode, unless the reverse flag is set, which swaps CW for CCW and vice- versa. Also, M_cull_unchanged is mapped to M_cull_none.

◆ getReverse()

bool getReverse ( )

Returns the 'reverse' flag.

If this is true, the actual cull direction (clockwise vs. counterclockwise) is the reverse of what is specified here. This allows support for make_reverse(), which defines a CullFaceAttrib that reverses whatever the sense of culling would have been.

◆ make()

static const RenderAttrib make ( CullFaceAttrib::Mode  mode)
static

Constructs a new CullFaceAttrib object that specifies how to cull geometry.

By Panda convention, vertices are ordered counterclockwise when seen from the front, so the M_cull_clockwise will cull backfacing polygons.

M_cull_unchanged is an identity attrib; if this is applied to vertices without any other intervening attrib, it is the same as applying the default attrib.

◆ 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.

◆ makeReverse()

static const RenderAttrib makeReverse ( )
static

Constructs a new CullFaceAttrib object that reverses the effects of any other CullFaceAttrib objects in the scene graph.

M_cull_clockwise will be treated as M_cull_counter_clockwise, and vice-versa. M_cull_none is unchanged.

Member Data Documentation

◆ class_slot

int class_slot

◆ effective_mode

CullFaceAttrib::Mode effective_mode

Returns the effective culling mode.

This is the same as the actual culling mode, unless the reverse flag is set, which swaps CW for CCW and vice- versa. Also, M_cull_unchanged is mapped to M_cull_none.

◆ mode

Returns the actual culling mode, without considering the effects of the reverse flag.

See also get_effective_mode().

◆ reverse

bool reverse

Returns the 'reverse' flag.

If this is true, the actual cull direction (clockwise vs. counterclockwise) is the reverse of what is specified here. This allows support for make_reverse(), which defines a CullFaceAttrib that reverses whatever the sense of culling would have been.