Documentation - v19.12.0-dev
    Preparing search index...

    Interface GuidePathOptions

    Visual and animation options for a GuidePath. Every field is optional and falls back to DEFAULT_GUIDE_PATH_OPTIONS when omitted.

    interface GuidePathOptions {
        color?: ColorRepresentation;
        cornerRadius?: number;
        heightOffset?: number;
        opacity?: number;
        pointRadius?: number;
        segmentLength?: number;
        segmentSpacing?: number;
        smoothing?: number;
        speed?: number;
        thickness?: number;
    }
    Index

    Properties

    color? cornerRadius? heightOffset? opacity? pointRadius? segmentLength? segmentSpacing? smoothing? speed? thickness?

    Properties

    color?: ColorRepresentation
    cornerRadius?: number

    Portion of each adjacent segment used to round a corner (0 to 0.5).

    heightOffset?: number

    Visual offset above the ground, along the Y axis, in world units.

    opacity?: number
    pointRadius?: number

    Radius of the marker displayed at each control point.

    segmentLength?: number

    Length of each illuminated segment in world units.

    segmentSpacing?: number

    Space between illuminated segments in world units.

    smoothing?: number

    Number of samples generated for each pair of control points.

    speed?: number

    Animation speed in world units per second.

    thickness?: number

    Line width in screen pixels.

    Settings

    Member Visibility

    On This Page

    Properties