# BillboardEffect¶

from panda3d.core import BillboardEffect

class BillboardEffect

Bases: RenderEffect

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

Inheritance diagram

getAxialRotate()bool

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

static getClassType()TypeHandle
getEyeRelative()bool

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

getFixedDepth()bool

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

getLookAt()NodePath

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()LPoint3

Returns the point, relative to the lookAt() node, towards which the billboard will rotate. Normally this is (0, 0, 0).

getOffset()float

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()LVector3

Returns the up vector in effect for this billboard.

isOff()bool

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().

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

Constructs a new BillboardEffect object with the indicated properties.

static makeAxis()RenderEffect

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

static makePointEye()RenderEffect

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

static makePointWorld()RenderEffect

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