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

A CompassEffect causes a node to inherit its rotation (or pos or scale, if specified) from some other reference node in the graph, or more often from the root. More...

Inheritance diagram for CompassEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Types

enum  Properties {
  P_x = 1, P_y = 2, P_z = 4, P_pos = 7,
  P_rot = 8, P_sx = 16, P_sy = 32, P_sz = 64,
  P_scale = 112, P_all = 127
}
 

Public Member Functions

int getProperties ()
 Returns the bitmask of properties that this CompassEffect object inherits from its reference node (or from the root). More...
 
const NodePath getReference ()
 Returns the reference node from which the CompassEffect inherits its transform. More...
 
- Public Member Functions inherited from RenderEffect
int compareTo (const RenderEffect other)
 Provides an arbitrary ordering among all unique RenderEffects, so we can store the essentially different ones in a big set and throw away the rest. 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 TypeHandle getClassType ()
 
static const RenderEffect make (const NodePath reference, int properties)
 Constructs a new CompassEffect object. More...
 
- Static Public Member Functions inherited from RenderEffect
static TypeHandle getClassType ()
 
static int getNumEffects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
static listEffects (Ostream out)
 Lists all of the RenderEffects in the cache to the output stream, one per line. More...
 
static bool validateEffects ()
 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 ()
 

Additional Inherited Members

- 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

A CompassEffect causes a node to inherit its rotation (or pos or scale, if specified) from some other reference node in the graph, or more often from the root.

In its purest form, a CompassEffect is used to keep the node's rotation fixed relative to the top of the scene graph, despite other transforms that may exist above the node. Hence the name: the node behaves like a magnetic compass, always pointing in the same direction.

As an couple of generalizing extensions, the CompassEffect may also be set up to always orient its node according to some other reference node than the root of the scene graph. Furthermore, it may optionally adjust any of pos, rotation, or scale, instead of necessarily rotation; and it may adjust individual pos and scale components. (Rotation may not be adjusted on an individual component basis; that's just asking for trouble.)

Be careful when using the pos and scale modes. In these modes, it's possible for the CompassEffect to move its node far from its normal bounding volume, causing culling to fail. If this is an issue, you may need to explicitly set a large (or infinite) bounding volume on the effect node.

Member Enumeration Documentation

◆ Properties

enum Properties
Enumerator
P_x 
P_y 
P_z 
P_pos 
P_rot 
P_sx 
P_sy 
P_sz 
P_scale 
P_all 

Member Function Documentation

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getProperties()

int getProperties ( )

Returns the bitmask of properties that this CompassEffect object inherits from its reference node (or from the root).

◆ getReference()

const NodePath getReference ( )

Returns the reference node from which the CompassEffect inherits its transform.

If this is empty, it means the root of the scene graph.

◆ make()

static const RenderEffect make ( const NodePath  reference,
int  properties 
)
static

Constructs a new CompassEffect object.

If the reference is an empty NodePath, it means the CompassEffect is relative to the root of the scene graph; otherwise, it's relative to the indicated node. The properties bitmask specifies the set of properties that the compass node inherits from the reference instead of from its parent.