Panda3D
 All Classes Functions Variables Enumerations
Public Member Functions | Static Public Member Functions | List of all members
CollisionRay Class Reference

An infinite ray, with a specific origin and direction. More...

#include "collisionRay.h"

Inheritance diagram for CollisionRay:
CollisionSolid CopyOnWriteObject CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase CollisionLine

Public Member Functions

 CollisionRay ()
 Creates an invalid ray. More...
 
 CollisionRay (const LPoint3 &origin, const LVector3 &direction)
 
 CollisionRay (PN_stdfloat ox, PN_stdfloat oy, PN_stdfloat oz, PN_stdfloat dx, PN_stdfloat dy, PN_stdfloat dz)
 
 CollisionRay (const CollisionRay &copy)
 
virtual TypeHandle force_init_type ()
 
virtual LPoint3 get_collision_origin () const
 Returns the point in space deemed to be the "origin" of the solid for collision purposes. More...
 
const LVector3get_direction () const
 
const LPoint3get_origin () const
 
virtual TypeHandle get_type () const
 
virtual CollisionSolidmake_copy ()
 
virtual void output (ostream &out) const
 
virtual PT (CollisionEntry) test_intersection(const CollisionEntry &entry) const
 
void set_direction (const LVector3 &direction)
 
void set_direction (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 
bool set_from_lens (LensNode *camera, const LPoint2 &point)
 Accepts a LensNode and a 2-d point in the range [-1,1]. More...
 
bool set_from_lens (LensNode *camera, PN_stdfloat px, PN_stdfloat py)
 Accepts a LensNode and a 2-d point in the range [-1,1]. More...
 
void set_origin (const LPoint3 &origin)
 
void set_origin (PN_stdfloat x, PN_stdfloat y, PN_stdfloat z)
 
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 solid by the indicated matrix. More...
 
- Public Member Functions inherited from CollisionSolid
 CollisionSolid (const CollisionSolid &copy)
 
void clear_effective_normal ()
 Removes the normal previously set by set_effective_normal(). More...
 
 CPT (BoundingVolume) get_bounds() const
 
const LVector3get_effective_normal () const
 Returns the normal that was set by set_effective_normal(). More...
 
bool get_respect_effective_normal () const
 See set_respect_effective_normal(). More...
 
virtual PStatCollectorget_test_pcollector ()
 Returns a PStatCollector that is used to count the number of intersection tests made against a solid of this type in a given frame. More...
 
virtual PStatCollectorget_volume_pcollector ()
 Returns a PStatCollector that is used to count the number of bounding volume tests made against a solid of this type in a given frame. More...
 
bool has_effective_normal () const
 Returns true if a special normal was set by set_effective_normal(), false otherwise. More...
 
bool is_tangible () const
 Returns whether the solid is considered 'tangible' or not. More...
 
virtual PT (PandaNode) get_viz(const CullTraverser *trav
 
void set_bounds (const BoundingVolume &bounding_volume)
 Returns the solid's bounding volume. More...
 
void set_effective_normal (const LVector3 &effective_normal)
 Records a false normal for this CollisionSolid that will be reported by the collision system with all collisions into it, instead of its actual normal. More...
 
void set_respect_effective_normal (bool respect_effective_normal)
 This is only meaningful for CollisionSolids that will be added to a traverser as colliders. More...
 
void set_tangible (bool tangible)
 Sets the current state of the 'tangible' flag. More...
 
virtual void write (ostream &out, int indent_level=0) const
 
- Public Member Functions inherited from CopyOnWriteObject
 CopyOnWriteObject (const CopyOnWriteObject &copy)
 
void operator= (const CopyOnWriteObject &copy)
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
void cache_ref () const
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
bool cache_unref () const
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int get_cache_ref_count () const
 Returns the current 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...
 
- 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)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
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...
 
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 &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...
 

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 CollisionRay. More...
 
- Static Public Member Functions inherited from CollisionSolid
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CopyOnWriteObject
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- 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 ()
 

Additional Inherited Members

- Public Attributes inherited from CollisionSolid
virtual const
CullTraverserData bool
bounds_only 
const
 
virtual const CullTraverserDatadata
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

An infinite ray, with a specific origin and direction.

It begins at its origin and continues in one direction to infinity, and it has no radius. Useful for picking from a window, or for gravity effects.

Definition at line 31 of file collisionRay.h.

Constructor & Destructor Documentation

CollisionRay::CollisionRay ( )
inline

Creates an invalid ray.

This isn't terribly useful; it's expected that the user will subsequently adjust the ray via set_origin()/set_direction() or set_from_lens().

Definition at line 25 of file collisionRay.I.

Member Function Documentation

LPoint3 CollisionRay::get_collision_origin ( ) const
virtual

Returns the point in space deemed to be the "origin" of the solid for collision purposes.

The closest intersection point to this origin point is considered to be the most significant.

Implements CollisionSolid.

Definition at line 77 of file collisionRay.cxx.

void CollisionRay::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type CollisionRay.

Definition at line 182 of file collisionRay.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

bool CollisionRay::set_from_lens ( LensNode camera,
const LPoint2 point 
)

Accepts a LensNode and a 2-d point in the range [-1,1].

Sets the CollisionRay so that it begins at the LensNode's near plane and extends to infinity, making it suitable for picking objects from the screen given a camera and a mouse location.

Returns true if the point was acceptable, false otherwise.

Definition at line 104 of file collisionRay.cxx.

References Lens::extrude(), LVector3f::forward(), LensNode::get_lens(), and LPoint3f::origin().

Referenced by set_from_lens().

bool CollisionRay::set_from_lens ( LensNode camera,
PN_stdfloat  px,
PN_stdfloat  py 
)
inline

Accepts a LensNode and a 2-d point in the range [-1,1].

Sets the CollisionRay so that it begins at the LensNode's near plane and extends to infinity, making it suitable for picking objects from the screen given a camera and a mouse location.

Definition at line 144 of file collisionRay.I.

References set_from_lens().

void CollisionRay::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 CollisionSolid.

Reimplemented in CollisionLine.

Definition at line 193 of file collisionRay.cxx.

References CollisionSolid::write_datagram(), and LVecBase3f::write_datagram().

Referenced by CollisionLine::write_datagram().

virtual void CollisionRay::xform ( const LMatrix4 mat)
virtual

Transforms the solid by the indicated matrix.

Reimplemented from CollisionSolid.


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