Class Ray

A ray emitted from an origin in a given direction.

The contents of the graphene_ray_t structure are private, and should not be modified directly.

record

Hierarchy

Ray

Constructors

constructor

new Ray(): Ray

Returns Ray

Properties

Static name

name: string

Methods

equal

equal(b: Ray): boolean

- Defined in Graphene-1.0.d.ts:1975
Checks whether the two given #graphene_ray_t are equal.

Parameters
- b: Ray
  
  a #graphene_ray_t
Returns boolean

free

free(): void

- Defined in Graphene-1.0.d.ts:1979
Frees the resources allocated by graphene_ray_alloc().

Returns void

getClosestPointToPoint

getClosestPointToPoint(p: Point3D): Point3D

- Defined in Graphene-1.0.d.ts:1985
Computes the point on the given #graphene_ray_t that is closest to the given point p.

Parameters
- p: Point3D
  
  a #graphene_point3d_t
Returns Point3D

getDirection

getDirection(): Graphene.Vec3

- Defined in Graphene-1.0.d.ts:1989
Retrieves the direction of the given #graphene_ray_t.

Returns Graphene.Vec3

getDistanceToPlane

getDistanceToPlane(p: Plane): number

- Defined in Graphene-1.0.d.ts:1997
Computes the distance of the origin of the given #graphene_ray_t from the given plane.

If the ray does not intersect the plane, this function returns INFINITY.

Parameters
- p: Plane
  
  a #graphene_plane_t
Returns number

getDistanceToPoint

getDistanceToPoint(p: Point3D): number

- Defined in Graphene-1.0.d.ts:2007
Computes the distance of the closest approach between the given #graphene_ray_t r and the point p.

The closest approach to a ray from a point is the distance between the point and the projection of the point on the ray itself.

Parameters
- p: Point3D
  
  a #graphene_point3d_t
Returns number

getOrigin

getOrigin(): Point3D

- Defined in Graphene-1.0.d.ts:2011
Retrieves the origin of the given #graphene_ray_t.

Returns Point3D

getPositionAt

getPositionAt(t: number): Point3D

- Defined in Graphene-1.0.d.ts:2017
Retrieves the coordinates of a point at the distance t along the given #graphene_ray_t.

Parameters
- t: number
  
  the distance along the ray
Returns Point3D

init

init(origin: Point3D, direction: Graphene.Vec3): Ray

- Defined in Graphene-1.0.d.ts:2024
Initializes the given #graphene_ray_t using the given origin and direction values.

Parameters
- origin: Point3D
  
  the origin of the ray
- direction: Graphene.Vec3
  
  the direction vector
Returns Ray

initFromRay

initFromRay(src: Ray): Ray

- Defined in Graphene-1.0.d.ts:2030
Initializes the given #graphene_ray_t using the origin and direction values of another #graphene_ray_t.

Parameters
- src: Ray
  
  a #graphene_ray_t
Returns Ray

initFromVec3

initFromVec3(origin: Graphene.Vec3, direction: Graphene.Vec3): Ray

- Defined in Graphene-1.0.d.ts:2036
Initializes the given #graphene_ray_t using the given vectors.

Parameters
- origin: Graphene.Vec3
  
  a #graphene_vec3_t
- direction: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Ray

intersectBox

intersectBox(b: Graphene.Box): [RayIntersectionKind, number]

- Defined in Graphene-1.0.d.ts:2042
Intersects the given #graphene_ray_t r with the given #graphene_box_t b.

Parameters
- b: Graphene.Box
  
  a #graphene_box_t
Returns [RayIntersectionKind, number]

intersectSphere

intersectSphere(s: Sphere): [RayIntersectionKind, number]

- Defined in Graphene-1.0.d.ts:2048
Intersects the given #graphene_ray_t r with the given #graphene_sphere_t s.

Parameters
- s: Sphere
  
  a #graphene_sphere_t
Returns [RayIntersectionKind, number]

intersectTriangle

intersectTriangle(t: Triangle): [RayIntersectionKind, number]

- Defined in Graphene-1.0.d.ts:2054
Intersects the given #graphene_ray_t r with the given #graphene_triangle_t t.

Parameters
- t: Triangle
  
  a #graphene_triangle_t
Returns [RayIntersectionKind, number]

intersectsBox

intersectsBox(b: Graphene.Box): boolean

- Defined in Graphene-1.0.d.ts:2062
Checks whether the given #graphene_ray_t r intersects the given #graphene_box_t b.

See also: graphene_ray_intersect_box()

Parameters
- b: Graphene.Box
  
  a #graphene_box_t
Returns boolean

intersectsSphere

intersectsSphere(s: Sphere): boolean

- Defined in Graphene-1.0.d.ts:2070
Checks if the given #graphene_ray_t r intersects the given #graphene_sphere_t s.

See also: graphene_ray_intersect_sphere()

Parameters
- s: Sphere
  
  a #graphene_sphere_t
Returns boolean

intersectsTriangle

intersectsTriangle(t: Triangle): boolean

- Defined in Graphene-1.0.d.ts:2078
Checks whether the given #graphene_ray_t r intersects the given #graphene_triangle_t b.

See also: graphene_ray_intersect_triangle()

Parameters
- t: Triangle
  
  a #graphene_triangle_t
Returns boolean

Static alloc

alloc(): Ray

- Defined in Graphene-1.0.d.ts:2102
Allocates a new #graphene_ray_t structure.

The contents of the returned structure are undefined.

Returns Ray