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.
enumerator P_x = 1
enumerator P_y = 2
enumerator P_z = 4
enumerator P_pos = 7
enumerator P_rot = 8
enumerator P_sx = 16
enumerator P_sy = 32
enumerator P_sz = 64
enumerator P_scale = 112
enumerator P_all = 127
- enumerator P_x = 1
int get_properties(void) const
Returns the bitmask of properties that this
CompassEffectobject inherits from its reference node (or from the root).
NodePath const &get_reference(void) const
Returns the reference node from which the
CompassEffectinherits its transform. If this is empty, it means the root of the scene graph.
static ConstPointerTo<RenderEffect> make(NodePath const &reference, int properties = P_rot)
Constructs a new
CompassEffectobject. If the reference is an empty
NodePath, it means the
CompassEffectis 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.
- enum Properties