Interface TriangleHit

Description

Triangle hit information, available when a ray cast intersects a collision mesh.

Example

var probe = Physics.createGlobalProbe();

function printHit(hit) {
    var tri = hit.triangle;
    if (tri) {
        print("triangle: " + tri);
        print("mesh: " + tri.mesh);
        print("index: " + tri.index);
        print("vertexIndices: " + tri.vertexIndices);
        print("vertexPositions: " + tri.vertexPositions);
        print("barycentricCoordinate: " + tri.barycentricCoordinate);
    }
}

probe.rayCast(fromPos, toPos, function onHitNearest(hit) {
    if (hit) {
        printHit(hit);
    }
});
interface TriangleHit {
    barycentricCoordinate: vec3;
    index: number;
    mesh: CollisionMesh;
    vertexIndices: number[];
    vertexPositions: vec3[];
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

barycentricCoordinate index mesh vertexIndices vertexPositions

Methods

getTypeName isOfType isSame

Properties

Readonly barycentricCoordinate

barycentricCoordinate: vec3

Description

Barycentric coordinate of the hit on the triangle. This is used to interpolate values over the triangle surface. Essentially, these are weights for each of the 3 triangle vertices. For example, you can compute the hit position from vertex positions as: (V0*b0 + V1*b1 + V2*b2). We already have the hit position in RayCastHit, but 'V' can be any interpolated value, such as color or texture coordinate.

Readonly index

index: number

Description

Index of the triangle in the mesh. Note, this is the index of the triangle in the collision mesh, which won't necessarily correspond to the same index on the render mesh (depending on type and bake settings).

Readonly mesh

mesh: CollisionMesh

Description

Collision mesh containing the triangle.

Readonly vertexIndices

vertexIndices: number[]

Description

Vertex indices in the mesh. Note, these are the indices of the vertices in the collision mesh, which won't necessarily correspond to the same indices in the render mesh (depending on type and bake settings).

Readonly vertexPositions

vertexPositions: vec3[]

Description

World-space vertex positions.

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc