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

Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node. More...

Inheritance diagram for BillboardEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

bool getAxialRotate ()
 Returns true if this billboard rotates only around the axis of the up vector, or false if it rotates freely in three dimensions. More...
 
bool getEyeRelative ()
 Returns true if this billboard interprets the up vector relative to the camera, or false if it is relative to the world. More...
 
bool getFixedDepth ()
 Returns true if this billboard always appears at a fixed distance from the camera. More...
 
const NodePath getLookAt ()
 Returns the node this billboard will rotate to look towards. More...
 
const LPoint3 getLookAtPoint ()
 Returns the point, relative to the look_at node, towards which the billboard will rotate. More...
 
float getOffset ()
 Returns the distance toward the camera (or the look_at_point) the billboard is moved towards, after rotating. More...
 
const LVector3 getUpVector ()
 Returns the up vector in effect for this billboard. More...
 
bool isOff ()
 Returns true if the BillboardEffect is an 'off' BillboardEffect, indicating that it does not enable billboarding. 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 LVector3 up_vector, bool eye_relative, bool axial_rotate, float offset, const NodePath look_at, const LPoint3 look_at_point, bool fixed_depth)
 Constructs a new BillboardEffect object with the indicated properties. More...
 
static const RenderEffect makeAxis ()
 A convenience function to make a typical axis-rotating billboard. More...
 
static const RenderEffect makePointEye ()
 A convenience function to make a typical eye-relative point-rotating billboard. More...
 
static const RenderEffect makePointWorld ()
 A convenience function to make a typical world-relative point-rotating billboard. 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

Indicates that geometry at this node should automatically rotate to face the camera, or any other arbitrary node.

Member Function Documentation

◆ getAxialRotate()

bool getAxialRotate ( )

Returns true if this billboard rotates only around the axis of the up vector, or false if it rotates freely in three dimensions.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getEyeRelative()

bool getEyeRelative ( )

Returns true if this billboard interprets the up vector relative to the camera, or false if it is relative to the world.

◆ getFixedDepth()

bool getFixedDepth ( )

Returns true if this billboard always appears at a fixed distance from the camera.

◆ getLookAt()

const NodePath getLookAt ( )

Returns the node this billboard will rotate to look towards.

If this is empty, it means the billboard will rotate towards the current camera node, wherever that might be.

◆ getLookAtPoint()

const LPoint3 getLookAtPoint ( )

Returns the point, relative to the look_at node, towards which the billboard will rotate.

Normally this is (0, 0, 0).

◆ getOffset()

float getOffset ( )

Returns the distance toward the camera (or the look_at_point) the billboard is moved towards, after rotating.

This can be used to ensure the billboard is not obscured by nearby geometry.

◆ getUpVector()

const LVector3 getUpVector ( )

Returns the up vector in effect for this billboard.

◆ isOff()

bool isOff ( )

Returns true if the BillboardEffect is an 'off' BillboardEffect, indicating that it does not enable billboarding.

This kind of BillboardEffect isn't particularly useful and isn't normally created or stored in the graph; it might be implicitly discovered as the result of a NodePath::get_rel_state().

◆ make()

static const RenderEffect make ( const LVector3  up_vector,
bool  eye_relative,
bool  axial_rotate,
float  offset,
const NodePath  look_at,
const LPoint3  look_at_point,
bool  fixed_depth 
)
static

Constructs a new BillboardEffect object with the indicated properties.

◆ makeAxis()

static const RenderEffect makeAxis ( )
static

A convenience function to make a typical axis-rotating billboard.

◆ makePointEye()

static const RenderEffect makePointEye ( )
static

A convenience function to make a typical eye-relative point-rotating billboard.

◆ makePointWorld()

static const RenderEffect makePointWorld ( )
static

A convenience function to make a typical world-relative point-rotating billboard.