Main Content

RayPath

R2026b

Geometric ray path between two points

Since R2026b

    Description

    Add-On Required: This feature requires the 3D Scenarios add-on.

    A RayPath object represents a geometric ray path between two points, including any interactions along the path.

    Creation

    Get RayPath objects by using the findpaths function. The function returns RayPathSet objects, which store RayPath objects in the Paths property.

    Properties

    expand all

    This property is read-only.

    Interactions along the ray path, represented as an m-by-1 vector of SpecularReflection objects. Each element of Interactions describes an interaction point where the ray reflects off a surface.

    The SpecularReflection object has two properties:

    • Type — Type of interaction, returned as "specular-reflection".

    • Material — Material at the interaction point, returned as a string scalar. Get all the materials reported by a scene or actor by using the materials function. When a ray path interacts with a material that has no catalog match, such that the MatchedCatalogMaterial variable reported by materials is "", the Material property of the SpecularReflection object is "concrete".

    Object Functions

    aoaAngle of arrival
    aodAngle of departure
    propdistPropagation distance
    reverseReverse direction of ray path
    plotPlot ray paths in 3D scenario viewer

    Version History

    Introduced in R2026b

    See Also

    Functions

    Objects