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...
#include "compassEffect.h"
Public Types | |
| enum | Properties { P_x = 0x001, P_y = 0x002, P_z = 0x004, P_pos = 0x007, P_rot = 0x008, P_sx = 0x010, P_sy = 0x020, P_sz = 0x040, P_scale = 0x070, P_all = 0x07f } |
Public Member Functions | |
| virtual void | adjust_transform (CPT(TransformState) &net_transform, CPT(TransformState) &node_transform, const PandaNode *node) const |
| Performs some operation on the node's apparent net and/or local transforms. More... | |
| virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
| Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
| virtual void | cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState) &node_transform, CPT(RenderState) &node_state) const |
| If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More... | |
| virtual TypeHandle | force_init_type () |
| int | get_properties () const |
| Returns the bitmask of properties that this CompassEffect object inherits from its reference node (or from the root). More... | |
| const NodePath & | get_reference () const |
| Returns the reference node from which the CompassEffect inherits its transform. More... | |
| virtual TypeHandle | get_type () const |
| virtual bool | has_adjust_transform () const |
| Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms. More... | |
| virtual bool | has_cull_callback () const |
| Should be overridden by derived classes to return true if cull_callback() has been defined. More... | |
| virtual void | output (std::ostream &out) const |
| virtual bool | safe_to_transform () const |
| Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise. More... | |
| virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
| Writes the contents of this object to the datagram for shipping out to a Bam file. More... | |
 Public Member Functions inherited from RenderEffect | |
| RenderEffect (const RenderEffect ©)=delete | |
| virtual | ~RenderEffect () |
| The destructor is responsible for removing the RenderEffect from the global set if it is there. More... | |
| int | compare_to (const RenderEffect &other) const |
| 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... | |
| virtual | CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const |
| virtual void | finalize (BamReader *manager) |
| Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More... | |
| RenderEffect & | operator= (const RenderEffect ©)=delete |
| virtual bool | safe_to_combine () const |
| virtual void | write (std::ostream &out, int indent_level) const |
| Public Member Functions inherited from TypedWritableReferenceCount | |
| TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
| virtual ReferenceCount * | as_reference_count () |
| Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
| void | operator= (const TypedWritableReferenceCount ©) |
| Public Member Functions inherited from TypedWritable | |
| TypedWritable (const TypedWritable ©) | |
| vector_uchar | encode_to_bam_stream () const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More... | |
| bool | encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
| UpdateSeq | get_bam_modified () const |
| Returns the current bam_modified counter. More... | |
| void | mark_bam_modified () |
| Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
| void | operator= (const TypedWritable ©) |
| virtual bool | require_fully_complete () const |
| Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More... | |
| virtual void | update_bam_nested (BamWriter *manager) |
| Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More... | |
| Public Member Functions inherited from TypedObject | |
| TypedObject (const TypedObject ©)=default | |
| TypedObject * | as_typed_object () |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| const TypedObject * | as_typed_object () const |
| Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
| int | get_best_parent_from_Set (const std::set< int > &) const |
| int | get_type_index () const |
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
| bool | is_exact_type (TypeHandle handle) const |
| Returns true if the current object is the indicated type exactly. More... | |
| bool | is_of_type (TypeHandle handle) const |
| Returns true if the current object is or derives from the indicated type. More... | |
| TypedObject & | operator= (const TypedObject ©)=default |
| Public Member Functions inherited from ReferenceCount | |
| int | get_ref_count () const |
| WeakReferenceList * | get_weak_list () const |
| Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
| bool | has_weak_list () const |
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
| void | local_object () |
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
| void | ref () const |
| Explicitly increments the reference count. More... | |
| bool | ref_if_nonzero () const |
| Atomically increases the reference count of this object if it is not zero. More... | |
| bool | test_ref_count_integrity () const |
| Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
| bool | test_ref_count_nonzero () const |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
| virtual bool | unref () const |
| Explicitly decrements the reference count. More... | |
| WeakReferenceList * | weak_ref () |
| Adds the indicated PointerToVoid as a weak reference to this object. More... | |
| void | weak_unref () |
| Removes the indicated PointerToVoid as a weak reference to this object. More... | |
Static Public Member Functions | |
| static | CPT (RenderEffect) make(const NodePath &reference |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static void | register_with_read_factory () |
| Tells the BamReader how to create objects of type CompassEffect. More... | |
| Static Public Member Functions inherited from RenderEffect | |
| static TypedWritable * | change_this (TypedWritable *old_ptr, BamReader *manager) |
| Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More... | |
| static TypeHandle | get_class_type () |
| static int | get_num_effects () |
| static void | init_type () |
| static void | list_effects (std::ostream &out) |
| Lists all of the RenderEffects in the cache to the output stream, one per line. More... | |
| static bool | validate_effects () |
| Ensures that the cache is still stored in sorted order. More... | |
| Static Public Member Functions inherited from TypedWritableReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data |
| Static Public Member Functions inherited from TypedWritable | |
| static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr) |
| Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More... | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| Static Public Member Functions inherited from TypedObject | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
| This function is declared non-inline to work around a compiler bug in g++ 2.96. More... | |
| Static Public Member Functions inherited from ReferenceCount | |
| static TypeHandle | get_class_type () |
| static void | init_type () |
Public Attributes | |
| static int | properties = P_rot) |
| Public Attributes inherited from TypedWritableReferenceCount | |
| static BamReader * | reader = nullptr) |
| Public Attributes inherited from TypedObject | |
| get_type | |
| Public Attributes inherited from ReferenceCount | |
| get_ref_count | |
| Returns the current reference count. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from TypedWritable | |
| static TypedWritable *const | Null = nullptr |
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.
Definition at line 46 of file compassEffect.h.
Member Function Documentation
◆ adjust_transform()
|
virtual |
Performs some operation on the node's apparent net and/or local transforms.
This will only be called if has_adjust_transform() is redefined to return true.
Both parameters are in/out. The original transforms will be passed in, and they may (or may not) be modified in-place by the RenderEffect.
Reimplemented from RenderEffect.
Definition at line 158 of file compassEffect.cxx.
References TransformState::get_pos, TransformState::get_quat, TransformState::get_scale, TransformState::has_components(), and NodePath::is_empty().
◆ complete_pointers()
|
virtual |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
Returns the number of pointers processed.
Reimplemented from TypedWritable.
Definition at line 298 of file compassEffect.cxx.
◆ cull_callback()
|
virtual |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.
At the time this function is called, the current node's transform and state have not yet been applied to the net_transform and net_state. This callback may modify the node_transform and node_state to apply an effective change to the render state at this level.
Reimplemented from RenderEffect.
Definition at line 115 of file compassEffect.cxx.
◆ get_properties()
|
inline |
Returns the bitmask of properties that this CompassEffect object inherits from its reference node (or from the root).
Definition at line 36 of file compassEffect.I.
◆ get_reference()
|
inline |
Returns the reference node from which the CompassEffect inherits its transform.
If this is empty, it means the root of the scene graph.
Definition at line 27 of file compassEffect.I.
◆ has_adjust_transform()
|
virtual |
Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms.
Reimplemented from RenderEffect.
Definition at line 145 of file compassEffect.cxx.
◆ has_cull_callback()
|
virtual |
Should be overridden by derived classes to return true if cull_callback() has been defined.
Otherwise, returns false to indicate cull_callback() does not need to be called for this effect during the cull traversal.
Reimplemented from RenderEffect.
Definition at line 98 of file compassEffect.cxx.
◆ register_with_read_factory()
|
static |
Tells the BamReader how to create objects of type CompassEffect.
Definition at line 275 of file compassEffect.cxx.
References BamReader::get_factory(), and Factory< Type >::register_factory().
Referenced by init_libpgraph().
◆ safe_to_transform()
|
virtual |
Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.
Reimplemented from RenderEffect.
Definition at line 45 of file compassEffect.cxx.
◆ write_datagram()
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderEffect.
Definition at line 284 of file compassEffect.cxx.
References Datagram::add_uint16(), BamWriter::get_file_minor_ver(), RenderEffect::write_datagram(), and NodePath::write_datagram().
The documentation for this class was generated from the following files:
- panda/src/pgraph/compassEffect.h
- panda/src/pgraph/compassEffect.cxx
- panda/src/pgraph/compassEffect.I
