Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Ray Class Reference

Ray is a line with one end. More...

Public Member Functions

 Ray ()
 Constructor.
 
 new ()
 Constructor.
 
 Ray (const Ray &ray)
 Constructor.
 
 Ray (const Vec3 &origin, const Vec3 &direction)
 Constructs a new ray initialized to the specified values. More...
 
 new ( local origin, local direction)
 Constructs a new ray initialized to the specified values. More...
 
 ~Ray ()
 Destructor.
 
bool intersects (const AABB &aabb, float *distance=nullptr) const
 Check whether this ray intersects with the specified AABB.
 
local intersects ( local aabb, local nullptr)
 Check whether this ray intersects with the specified AABB.
 
bool intersects (const OBB &obb, float *distance=nullptr) const
 Check whether this ray intersects with the specified OBB.
 
local intersects ( local obb, local nullptr)
 Check whether this ray intersects with the specified OBB.
 
void set (const Vec3 &origin, const Vec3 &direction)
 Sets this ray to the specified values. More...
 
local set ( local origin, local direction)
 Sets this ray to the specified values. More...
 
void transform (const Mat4 &matrix)
 Transforms this ray by the given transformation matrix. More...
 
local transform ( local matrix)
 Transforms this ray by the given transformation matrix. More...
 

Detailed Description

Ray is a line with one end.

usually use it to check intersects with some object,such as Plane, OBB, AABB

Constructor & Destructor Documentation

Ray ( const Vec3 origin,
const Vec3 direction 
)

Constructs a new ray initialized to the specified values.

Parameters
originThe ray's origin.
directionThe ray's direction.
local new ( local  origin,
local  direction 
)

Constructs a new ray initialized to the specified values.

Parameters
originThe ray's origin.
directionThe ray's direction.

Member Function Documentation

void set ( const Vec3 origin,
const Vec3 direction 
)

Sets this ray to the specified values.

Parameters
originThe ray's origin.
directionThe ray's direction.
local set ( local  origin,
local  direction 
)

Sets this ray to the specified values.

Parameters
originThe ray's origin.
directionThe ray's direction.
void transform ( const Mat4 matrix)

Transforms this ray by the given transformation matrix.

Parameters
matrixThe transformation matrix to transform by.
local transform ( local  matrix)

Transforms this ray by the given transformation matrix.

Parameters
matrixThe transformation matrix to transform by.

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