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

A node in the scene graph that can hold a Portal Polygon, which is a rectangle. More...

#include "portalNode.h"

Inheritance diagram for PortalNode:
PandaNode TypedWritableReferenceCount Namable LinkedListNode TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

Public Member Functions

 PortalNode (const string &name)
 Default constructor, just an empty node, no geo This is used to read portal from model. More...
 
 PortalNode (const string &name, LPoint3 pos, PN_stdfloat scale=10.0)
 Create a default rectangle as portal. More...
 
void add_vertex (const LPoint3 &vertex)
 Adds a new vertex to the portal polygon. More...
 
void clear_vertices ()
 Resets the vertices of the portal to the empty list. More...
 
virtual PandaNodecombine_with (PandaNode *other)
 Collapses this node with the other node, if possible, and returns a pointer to the combined node, or NULL if the two nodes cannot safely be combined. 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 bool cull_callback (CullTraverser *trav, CullTraverserData &data)
 This function will be called during the cull traversal to perform reduced frustum culling. More...
 
virtual void enable_clipping_planes ()
 initialize the clipping planes and renderstate More...
 
virtual TypeHandle force_init_type ()
 
NodePath get_cell_in () const
 Sets the cell that this portal belongs to. More...
 
NodePath get_cell_out () const
 Sets the cell that this portal leads out to. More...
 
PortalMask get_from_portal_mask () const
 Returns the current "from" PortalMask. More...
 
PortalMask get_into_portal_mask () const
 Returns the current "into" PortalMask. More...
 
int get_max_depth ()
 Returns the maximum depth this portal will be visible at. More...
 
int get_num_vertices () const
 Returns the number of vertices in the portal polygon. More...
 
bool get_portal_geom () const
 Returns the current state of the portal_geom flag. More...
 
virtual TypeHandle get_type () const
 
const LPoint3get_vertex (int n) const
 Returns the nth vertex of the portal polygon. More...
 
bool is_clip_plane ()
 Is this portal clipping against its left-right planes. More...
 
bool is_open ()
 Is this portal open from current camera zone. More...
 
virtual bool is_renderable () const
 Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...
 
bool is_visible ()
 Is this portal facing the camera. More...
 
virtual PandaNodemake_copy () const
 Returns a newly-allocated Node that is a shallow copy of this one. More...
 
 MAKE_SEQ (get_vertices, get_num_vertices, get_vertex)
 
virtual void output (ostream &out) const
 Writes a brief description of the node to the indicated output stream. More...
 
virtual bool preserve_name () const
 Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...
 
void set_cell_in (const NodePath &cell)
 Sets the cell that this portal belongs to. More...
 
void set_cell_out (const NodePath &cell)
 Sets the cell that this portal leads out to. More...
 
void set_clip_plane (bool value)
 this is set if the portal will clip against its left and right planes More...
 
void set_from_portal_mask (PortalMask mask)
 Sets the "from" PortalMask. More...
 
void set_into_portal_mask (PortalMask mask)
 Sets the "into" PortalMask. More...
 
void set_max_depth (int value)
 Set the maximum depth this portal will be visible at. More...
 
void set_open (bool value)
 Python sets this based on curent camera zone. More...
 
void set_portal_geom (bool flag)
 Sets the state of the "portal geom" flag for this PortalNode. More...
 
void set_portal_mask (PortalMask mask)
 Simultaneously sets both the "from" and "into" PortalMask values to the same thing. More...
 
void set_visible (bool value)
 this is set if the portal is facing camera 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...
 
virtual void xform (const LMatrix4 &mat)
 Transforms the contents of this node by the indicated matrix, if it means anything to do so. More...
 
- Public Member Functions inherited from PandaNode
 PandaNode (const string &name)
 
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 
virtual void add_for_draw (CullTraverser *trav, CullTraverserData &data)
 Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...
 
void add_stashed (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node, directly as a stashed child. More...
 
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
virtual void apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
 Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...
 
virtual Lightas_light ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
void clear_attrib (TypeHandle type)
 
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
void clear_bounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 
void clear_state (Thread *current_thread=Thread::get_current_thread())
 
void clear_tag (const string &key, Thread *current_thread=Thread::get_current_thread())
 Removes the value defined for this key on this particular node. More...
 
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 
void clear_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
int compare_tags (const PandaNode *other) const
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
void copy_all_properties (PandaNode *other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
void copy_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Makes another instance of all the children of the other node, copying them to this node. More...
 
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node. More...
 
int count_num_descendants () const
 
virtual CPT (TransformState) calc_tight_bounds(LPoint3 &min_point
 
 CPT (RenderAttrib) get_attrib(TypeHandle type) const
 
 CPT (RenderAttrib) get_attrib(int slot) const
 
 CPT (RenderEffect) get_effect(TypeHandle type) const
 
 CPT (RenderState) get_state(Thread *current_thread
 
 CPT (RenderEffects) get_effects(Thread *current_thread
 
 CPT (TransformState) get_transform(Thread *current_thread
 
 CPT (TransformState) get_prev_transform(Thread *current_thread
 
 CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(UpdateSeq &seq
 
 CPT (BoundingVolume) get_internal_bounds(Thread *current_thread
 
virtual PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...
 
int find_child (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int find_parent (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int find_stashed (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
BoundingVolume::BoundsType get_bounds_type () const
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth child node of this node. More...
 
int get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
Children get_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask get_draw_control_mask () const
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask get_draw_show_mask () const
 Returns the hide/show bits of this particular node. More...
 
int get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
virtual int get_first_visible_child () const
 Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...
 
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_into_collide_mask () const
 Returns the "into" collide mask for this node. More...
 
virtual CollideMask get_legal_collide_mask () const
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask get_net_draw_control_mask () const
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask get_net_draw_show_mask () const
 Returns the union of all draw_show_mask values–of renderable nodes only–at this level and below. More...
 
virtual int get_next_visible_child (int n) const
 Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...
 
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of child nodes this node has. More...
 
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of parent nodes this node has. More...
 
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of stashed nodes this node has. More...
 
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth parent node of this node. More...
 
Parents get_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth stashed child of this node. More...
 
Stashed get_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
int get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
string get_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
void get_tag_keys (vector_string &keys) const
 Fills the given vector up with the list of tags on this PandaNode. More...
 
unsigned int get_unexpected_change (unsigned int flags) const
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
virtual int get_unsafe_to_apply_attribs () const
 Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...
 
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node. More...
 
bool has_attrib (TypeHandle type) const
 
bool has_attrib (int slot) const
 
bool has_dirty_prev_transform () const
 
bool has_effect (TypeHandle type) const
 
virtual bool has_selective_visibility () const
 Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...
 
virtual bool has_single_child_visibility () const
 Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...
 
bool has_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 
bool has_tags () const
 
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool is_bounds_stale () const
 
virtual bool is_collision_node () const
 A simple downcast check. More...
 
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 Returns the current state of the "final" flag. More...
 
virtual bool is_geom_node () const
 A simple downcast check. More...
 
virtual bool is_lod_node () const
 A simple downcast check. More...
 
bool is_overall_hidden () const
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool is_scene_root () const
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool is_under_scene_root () const
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
void list_tags (ostream &out, const string &separator="\) const
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
void ls (ostream &out, int indent_level) const
 
 MAKE_SEQ (get_parents, get_num_parents, get_parent)
 
 MAKE_SEQ (get_children, get_num_children, get_child)
 
 MAKE_SEQ (get_stashed, get_num_stashed, get_stashed)
 
void mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const
 
void mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state)
 
 PT (PandaNode) copy_subgraph(Thread *current_thread
 
virtual void r_prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state, GeomTransformer &transformer, Thread *current_thread)
 The recursive implementation of prepare_scene(). More...
 
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children. More...
 
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node. More...
 
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node. More...
 
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node. More...
 
bool replace_child (PandaNode *orig_child, PandaNode *new_child, Thread *current_thread=Thread::get_current_thread())
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
void reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
virtual bool safe_to_combine () const
 Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...
 
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other. More...
 
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...
 
virtual bool safe_to_flatten_below () const
 Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...
 
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node. More...
 
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise. More...
 
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node. More...
 
void set_bound (const BoundingVolume *volume)
 Deprecated. More...
 
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderEffects that will be applied this node. More...
 
void set_final (bool flag)
 
void set_into_collide_mask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
void set_overall_hidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
void set_prev_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
void set_state (const RenderState *state, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
void set_tag (const string &key, const string &value, Thread *current_thread=Thread::get_current_thread())
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
void set_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that will be applied to this node and below. More...
 
void set_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node. More...
 
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. 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...
 
virtual void write (ostream &out, int indent_level) const
 
void write_recorder (BamWriter *manager, Datagram &dg)
 This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
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...
 
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 &copy)
 
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...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_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 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...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PortalNode. More...
 
- Static Public Member Functions inherited from PandaNode
static DrawMask get_all_camera_mask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle get_class_type ()
 
static DrawMask get_overall_bit ()
 
static void init_type ()
 
static PT (PandaNode) decode_from_bam_stream(const string &data
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PandaNode. More...
 
static void reset_all_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
static void set_scene_root_func (SceneRootFunc *func)
 This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. 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 ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010,
  FB_draw_mask = 0x0020, FB_cull_callback = 0x0040
}
 
typedef bool SceneRootFunc(const PandaNode *)
 
enum  UnexpectedChange {
  UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008,
  UC_draw_mask = 0x010
}
 
- Public Attributes inherited from PandaNode
virtual LPoint3 bool const TransformState Threadcurrent_thread = Thread::get_current_thread()) const
 
Threadcurrent_thread = Thread::get_current_thread()) const
 
virtual LPoint3 bool & found_any
 
virtual LPoint3max_point
 
static BamReaderreader = NULL)
 
virtual LPoint3 bool const TransformState * transform
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

A node in the scene graph that can hold a Portal Polygon, which is a rectangle.

Other types of polygons are not supported for now. It also holds a PT(PandaNode) Cell that this portal is connected to

Definition at line 34 of file portalNode.h.

Constructor & Destructor Documentation

◆ PortalNode() [1/2]

PortalNode::PortalNode ( const string &  name)

Default constructor, just an empty node, no geo This is used to read portal from model.

You can also use this from python to create an empty portal. Then you can set the vertices yourself, with addVertex.

Definition at line 46 of file portalNode.cxx.

Referenced by make_copy(), and PortalNode().

◆ PortalNode() [2/2]

PortalNode::PortalNode ( const string &  name,
LPoint3  pos,
PN_stdfloat  scale = 10.0 
)

Create a default rectangle as portal.

Use this to create an arbitrary portal and setup from Python

Definition at line 67 of file portalNode.cxx.

References add_vertex(), make_copy(), and PortalNode().

Member Function Documentation

◆ add_vertex()

void PortalNode::add_vertex ( const LPoint3 vertex)
inline

Adds a new vertex to the portal polygon.

The vertices should be defined in a counterclockwise orientation when viewing through the portal.

Definition at line 142 of file portalNode.I.

References get_num_vertices().

Referenced by clear_vertices(), EggLoader::make_polyset(), and PortalNode().

◆ clear_vertices()

void PortalNode::clear_vertices ( )
inline

Resets the vertices of the portal to the empty list.

Definition at line 130 of file portalNode.I.

References add_vertex().

Referenced by get_portal_geom(), and EggLoader::make_polyset().

◆ combine_with()

PandaNode * PortalNode::combine_with ( PandaNode other)
virtual

Collapses this node with the other node, if possible, and returns a pointer to the combined node, or NULL if the two nodes cannot safely be combined.

The return value may be this, other, or a new node altogether.

This function is called from GraphReducer::flatten(), and need not deal with children; its job is just to decide whether to collapse the two nodes and what the collapsed node should look like.

Reimplemented from PandaNode.

Definition at line 198 of file portalNode.cxx.

References PandaNode::combine_with(), cull_callback(), and TypedObject::is_exact_type().

Referenced by xform().

◆ complete_pointers()

int PortalNode::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
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 469 of file portalNode.cxx.

◆ cull_callback()

bool PortalNode::cull_callback ( CullTraverser trav,
CullTraverserData data 
)
virtual

This function will be called during the cull traversal to perform reduced frustum culling.

Basically, once the scenegraph comes across a portal node, it calculates a CulltraverserData with which cell, this portal leads out to and the new frustum. Then it traverses that child

The return value is true if this node should be visible, or false if it should be culled.

Reimplemented from PandaNode.

Definition at line 229 of file portalNode.cxx.

References PortalClipper::get_clip_state(), SceneSetup::get_cull_center(), CullTraverser::get_current_thread(), NodePath::get_name(), WorkingNodePath::get_node_path(), CullTraverser::get_portal_clipper(), PortalClipper::get_reduced_frustum(), PortalClipper::get_reduced_viewport(), CullTraverser::get_view_frustum(), NodePath::is_empty(), is_open(), is_renderable(), PortalClipper::prepare_portal(), PortalClipper::set_clip_state(), PortalClipper::set_reduced_frustum(), PortalClipper::set_reduced_viewport(), set_visible(), and CullTraverser::traverse_below().

Referenced by combine_with().

◆ enable_clipping_planes()

void PortalNode::enable_clipping_planes ( )
virtual

initialize the clipping planes and renderstate

Definition at line 147 of file portalNode.cxx.

References NodePath::attach_new_node(), and xform().

Referenced by preserve_name(), and set_clip_plane().

◆ get_cell_in()

NodePath PortalNode::get_cell_in ( ) const
inline

Sets the cell that this portal belongs to.

Definition at line 181 of file portalNode.I.

◆ get_cell_out()

NodePath PortalNode::get_cell_out ( ) const
inline

Sets the cell that this portal leads out to.

Definition at line 198 of file portalNode.I.

◆ get_from_portal_mask()

PortalMask PortalNode::get_from_portal_mask ( ) const
inline

Returns the current "from" PortalMask.

In order for a portal to be detected from this object into another object, the intersection of this object's "from" mask and the other object's "into" mask must be nonzero.

Definition at line 71 of file portalNode.I.

References get_into_portal_mask().

Referenced by set_into_portal_mask().

◆ get_into_portal_mask()

PortalMask PortalNode::get_into_portal_mask ( ) const
inline

Returns the current "into" PortalMask.

In order for a portal to be detected from another object into this object, the intersection of the other object's "from" mask and this object's "into" mask must be nonzero.

Definition at line 85 of file portalNode.I.

References set_portal_geom().

Referenced by get_from_portal_mask().

◆ get_max_depth()

int PortalNode::get_max_depth ( )
inline

Returns the maximum depth this portal will be visible at.

Definition at line 275 of file portalNode.I.

◆ get_num_vertices()

int PortalNode::get_num_vertices ( ) const
inline

Returns the number of vertices in the portal polygon.

Definition at line 152 of file portalNode.I.

References get_vertex().

Referenced by add_vertex(), and EggLoader::make_polyset().

◆ get_portal_geom()

bool PortalNode::get_portal_geom ( ) const
inline

Returns the current state of the portal_geom flag.

See set_portal_geom().

Definition at line 120 of file portalNode.I.

References clear_vertices().

Referenced by set_portal_geom().

◆ get_vertex()

const LPoint3 & PortalNode::get_vertex ( int  n) const
inline

Returns the nth vertex of the portal polygon.

Definition at line 162 of file portalNode.I.

References LPoint3f::zero().

Referenced by get_num_vertices().

◆ is_clip_plane()

bool PortalNode::is_clip_plane ( )
inline

Is this portal clipping against its left-right planes.

Definition at line 220 of file portalNode.I.

◆ is_open()

bool PortalNode::is_open ( )
inline

Is this portal open from current camera zone.

Definition at line 257 of file portalNode.I.

Referenced by cull_callback().

◆ is_renderable()

bool PortalNode::is_renderable ( ) const
virtual

Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise.

This will be used to optimize the result of get_net_draw_show_mask(), so that any subtrees that contain only nodes for which is_renderable() is false need not be visited.

Reimplemented from PandaNode.

Definition at line 344 of file portalNode.cxx.

References output().

Referenced by cull_callback().

◆ is_visible()

bool PortalNode::is_visible ( )
inline

Is this portal facing the camera.

Definition at line 239 of file portalNode.I.

◆ make_copy()

PandaNode * PortalNode::make_copy ( ) const
virtual

Returns a newly-allocated Node that is a shallow copy of this one.

It will be a different Node pointer, but its internal data may or may not be shared with that of the original Node.

Reimplemented from PandaNode.

Definition at line 125 of file portalNode.cxx.

References PortalNode(), and preserve_name().

Referenced by PortalNode().

◆ output()

void PortalNode::output ( ostream &  out) const
virtual

Writes a brief description of the node to the indicated output stream.

This is invoked by the << operator. It may be overridden in derived classes to include some information relevant to the class.

Reimplemented from PandaNode.

Definition at line 358 of file portalNode.cxx.

Referenced by is_renderable().

◆ preserve_name()

bool PortalNode::preserve_name ( ) const
virtual

Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise.

Reimplemented from PandaNode.

Definition at line 137 of file portalNode.cxx.

References enable_clipping_planes().

Referenced by make_copy().

◆ register_with_read_factory()

void PortalNode::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type PortalNode.

Definition at line 439 of file portalNode.cxx.

◆ set_cell_in()

void PortalNode::set_cell_in ( const NodePath cell)
inline

Sets the cell that this portal belongs to.

Definition at line 172 of file portalNode.I.

◆ set_cell_out()

void PortalNode::set_cell_out ( const NodePath cell)
inline

Sets the cell that this portal leads out to.

Definition at line 189 of file portalNode.I.

◆ set_clip_plane()

void PortalNode::set_clip_plane ( bool  value)
inline

this is set if the portal will clip against its left and right planes

Definition at line 208 of file portalNode.I.

References enable_clipping_planes().

◆ set_from_portal_mask()

void PortalNode::set_from_portal_mask ( PortalMask  mask)
inline

Sets the "from" PortalMask.

In order for a portal to be detected from this object into another object, the intersection of this object's "from" mask and the other object's "into" mask must be nonzero.

Definition at line 38 of file portalNode.I.

References set_into_portal_mask().

Referenced by set_portal_mask().

◆ set_into_portal_mask()

void PortalNode::set_into_portal_mask ( PortalMask  mask)
inline

Sets the "into" PortalMask.

In order for a portal to be detected from another object into this object, the intersection of the other object's "from" mask and this object's "into" mask must be nonzero.

Definition at line 52 of file portalNode.I.

References get_from_portal_mask().

Referenced by set_from_portal_mask(), and set_portal_mask().

◆ set_max_depth()

void PortalNode::set_max_depth ( int  value)
inline

Set the maximum depth this portal will be visible at.

Definition at line 266 of file portalNode.I.

◆ set_open()

void PortalNode::set_open ( bool  value)
inline

Python sets this based on curent camera zone.

Definition at line 248 of file portalNode.I.

◆ set_portal_geom()

void PortalNode::set_portal_geom ( bool  flag)
inline

Sets the state of the "portal geom" flag for this PortalNode.

Normally, this is false; when this is set true, the PortalSolids in this node will test for portals with actual renderable geometry, in addition to whatever PortalSolids may be indicated by the from_portal_mask.

Setting this to true causes this to test *all* GeomNodes for portals. It is an all-or-none thing; there is no way to portal with only some GeomNodes, as GeomNodes have no into_portal_mask.

Definition at line 105 of file portalNode.I.

References get_portal_geom().

Referenced by get_into_portal_mask().

◆ set_portal_mask()

void PortalNode::set_portal_mask ( PortalMask  mask)
inline

Simultaneously sets both the "from" and "into" PortalMask values to the same thing.

Definition at line 23 of file portalNode.I.

References set_from_portal_mask(), and set_into_portal_mask().

◆ set_visible()

void PortalNode::set_visible ( bool  value)
inline

this is set if the portal is facing camera

Definition at line 230 of file portalNode.I.

Referenced by cull_callback().

◆ write_datagram()

void PortalNode::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from PandaNode.

Definition at line 450 of file portalNode.cxx.

◆ xform()

void PortalNode::xform ( const LMatrix4 mat)
virtual

Transforms the contents of this node by the indicated matrix, if it means anything to do so.

For most kinds of nodes, this does nothing.

Reimplemented from PandaNode.

Definition at line 177 of file portalNode.cxx.

References combine_with(), and LMatrix4f::is_nan().

Referenced by enable_clipping_planes().


The documentation for this class was generated from the following files: