Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::RayIntersection Class Reference

The RayIntersection encapsulates all the information relative to a Ray/Actor intersection. More...

#include <RayIntersector.hpp>

+ Inheritance diagram for vl::RayIntersection:

Public Member Functions

 RayIntersection ()
 
void setActor (Actor *a)
 The intersected Actor. More...
 
const Actoractor () const
 The intersected Actor. More...
 
Actoractor ()
 The intersected Actor. More...
 
const vec3intersectionPoint () const
 The intersection point, in world coordinates. More...
 
void setIntersectionPoint (const vec3 &v)
 The intersection point, in world coordinates. More...
 
real distance () const
 The intersection distance. More...
 
void setDistance (real dist)
 The intersection distance. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

vec3 mIntersectionPoint
 
ActormActor
 
real mDistance
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

The RayIntersection encapsulates all the information relative to a Ray/Actor intersection.

Definition at line 50 of file RayIntersector.hpp.

Constructor & Destructor Documentation

◆ RayIntersection()

vl::RayIntersection::RayIntersection ( )
inline

Definition at line 55 of file RayIntersector.hpp.

Member Function Documentation

◆ actor() [1/2]

const Actor* vl::RayIntersection::actor ( ) const
inline

The intersected Actor.

Definition at line 63 of file RayIntersector.hpp.

References mActor.

◆ actor() [2/2]

Actor* vl::RayIntersection::actor ( )
inline

The intersected Actor.

Definition at line 65 of file RayIntersector.hpp.

References mActor.

◆ distance()

real vl::RayIntersection::distance ( ) const
inline

The intersection distance.

Definition at line 73 of file RayIntersector.hpp.

References mDistance.

◆ intersectionPoint()

const vec3& vl::RayIntersection::intersectionPoint ( ) const
inline

The intersection point, in world coordinates.

Definition at line 68 of file RayIntersector.hpp.

References mIntersectionPoint.

◆ setActor()

void vl::RayIntersection::setActor ( Actor a)
inline

The intersected Actor.

Definition at line 61 of file RayIntersector.hpp.

References mActor.

Referenced by vl::RayIntersector::intersectTriangle().

◆ setDistance()

void vl::RayIntersection::setDistance ( real  dist)
inline

The intersection distance.

Definition at line 75 of file RayIntersector.hpp.

References mDistance.

Referenced by vl::RayIntersector::intersectTriangle().

◆ setIntersectionPoint()

void vl::RayIntersection::setIntersectionPoint ( const vec3 v)
inline

The intersection point, in world coordinates.

Definition at line 70 of file RayIntersector.hpp.

References mIntersectionPoint.

Referenced by vl::RayIntersector::intersectTriangle().

Member Data Documentation

◆ mActor

Actor* vl::RayIntersection::mActor
protected

Definition at line 79 of file RayIntersector.hpp.

Referenced by actor(), and setActor().

◆ mDistance

real vl::RayIntersection::mDistance
protected

Definition at line 80 of file RayIntersector.hpp.

Referenced by distance(), and setDistance().

◆ mIntersectionPoint

vec3 vl::RayIntersection::mIntersectionPoint
protected

Definition at line 78 of file RayIntersector.hpp.

Referenced by intersectionPoint(), and setIntersectionPoint().


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