Graphene-1.0 ▶ Graphene ▶ RaySince 1.4

constructor

• new Ray(properties?: Partial<{}>): Ray

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Ray

Static$gtype

Since 1.4equal

• equal(b: Ray): boolean

  Checks whether the two given Graphene.Ray are equal.

  Parameters

  • b: Ray

    a Graphene.Ray

  Returns boolean

  true if the given rays are equal

  Since

  1.4

Since 1.4free

• free(): void

  Frees the resources allocated by graphene_ray_alloc().

  Returns void

  Since

  1.4

Since 1.4get_closest_point_to_point

• get_closest_point_to_point(p: Point3D): Point3D

  Computes the point on the given Graphene.Ray that is closest to the given point p.

  Parameters

  • p: Point3D

    a Graphene.Point3D

  Returns Point3D

  Since

  1.4

Since 1.4get_direction

• get_direction(): Vec3

  Retrieves the direction of the given Graphene.Ray.

  Returns Vec3

  Since

  1.4

Since 1.4get_distance_to_plane

• get_distance_to_plane(p: Plane): number

  Computes the distance of the origin of the given Graphene.Ray from the given plane.

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

  Parameters

  • p: Plane

    a Graphene.Plane

  Returns number

  the distance of the origin of the ray from the plane

  Since

  1.4

Since 1.4get_distance_to_point

• get_distance_to_point(p: Point3D): number

  Computes the distance of the closest approach between the given Graphene.Ray 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

  Returns number

  the distance of the point

  Since

  1.4

Since 1.4get_origin

• get_origin(): Point3D

  Retrieves the origin of the given Graphene.Ray.

  Returns Point3D

  Since

  1.4

Since 1.4get_position_at

• get_position_at(t: number): Point3D

  Retrieves the coordinates of a point at the distance t along the given Graphene.Ray.

  Parameters

  • t: number

    the distance along the ray

  Returns Point3D

  Since

  1.4

Since 1.4init

• init(origin: Point3D, direction: Vec3): Ray

  Initializes the given Graphene.Ray using the given origin and direction values.

  Parameters

  • origin: Point3D

    the origin of the ray

  • direction: Vec3

    the direction vector

  Returns Ray

  the initialized ray

  Since

  1.4

Since 1.4init_from_ray

• init_from_ray(src: Ray): Ray

  Initializes the given Graphene.Ray using the origin and direction values of another Graphene.Ray.

  Parameters

  • src: Ray

    a Graphene.Ray

  Returns Ray

  the initialized ray

  Since

  1.4

Since 1.4init_from_vec3

• init_from_vec3(origin: Vec3, direction: Vec3): Ray

  Initializes the given Graphene.Ray using the given vectors.

  Parameters

  • origin: Vec3

    a Graphene.Vec3

  • direction: Vec3

    a Graphene.Vec3

  Returns Ray

  the initialized ray

  Since

  1.4

Since 1.10intersect_box

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

  Intersects the given Graphene.Ray r with the given Graphene.Box b.

  Parameters

  • b: Graphene.Box

    a Graphene.Box

  Returns [RayIntersectionKind, number]

  the type of intersection

  Since

  1.10

Since 1.10intersect_sphere

• intersect_sphere(s: Sphere): [RayIntersectionKind, number]

  Intersects the given Graphene.Ray r with the given Graphene.Sphere s.

  Parameters

  • s: Sphere

    a Graphene.Sphere

  Returns [RayIntersectionKind, number]

  the type of intersection

  Since

  1.10

Since 1.10intersect_triangle

• intersect_triangle(t: Triangle): [RayIntersectionKind, number]

  Intersects the given Graphene.Ray r with the given Graphene.Triangle t.

  Parameters

  • t: Triangle

    a Graphene.Triangle

  Returns [RayIntersectionKind, number]

  the type of intersection

  Since

  1.10

Since 1.10intersects_box

• intersects_box(b: Graphene.Box): boolean

  Checks whether the given Graphene.Ray r intersects the given Graphene.Box b.

  See also: graphene_ray_intersect_box()

  Parameters

  • b: Graphene.Box

    a Graphene.Box

  Returns boolean

  true if the ray intersects the box

  Since

  1.10

Since 1.10intersects_sphere

• intersects_sphere(s: Sphere): boolean

  Checks if the given Graphene.Ray r intersects the given Graphene.Sphere s.

  See also: graphene_ray_intersect_sphere()

  Parameters

  • s: Sphere

    a Graphene.Sphere

  Returns boolean

  true if the ray intersects the sphere

  Since

  1.10

Since 1.10intersects_triangle

• intersects_triangle(t: Triangle): boolean

  Checks whether the given Graphene.Ray r intersects the given Graphene.Triangle b.

  See also: graphene_ray_intersect_triangle()

  Parameters

  • t: Triangle

    a Graphene.Triangle

  Returns boolean

  true if the ray intersects the triangle

  Since

  1.10

Staticalloc

• alloc(): Ray

  Returns Ray