Viewer - Interaction
    Preparing search index...

    Interface PlaneRestrictionProperties

    interface PlaneRestrictionProperties {
        type: RESTRICTION_TYPE;
        angularSnapRestriction?: AngularRestrictionProperties;
        axisSnapRestriction?: AxisRestrictionProperties;
        createHelperObjects?: boolean;
        gridSnapRestriction?: GridRestrictionProperties;
        hideable?: boolean;
        id?: string;
        origin?: vec3;
        priority?: number;
        rotation?: { angle: number; axis: vec3 };
        vector_u?: vec3;
        vector_v?: vec3;
    }

    Hierarchy (View Summary)

    Index

    Properties

    type angularSnapRestriction? axisSnapRestriction? createHelperObjects? gridSnapRestriction? hideable? id? origin? priority? rotation? vector_u? vector_v?

    Properties

    type: RESTRICTION_TYPE

    Type of the restriction

    angularSnapRestriction?: AngularRestrictionProperties

    angular snap restriction

    axisSnapRestriction?: AxisRestrictionProperties

    axis snap restriction

    createHelperObjects?: boolean

    Whether to create visual helper objects (grid, axis, etc.) for restrictions. (default: true)

    gridSnapRestriction?: GridRestrictionProperties

    grid snap restriction

    hideable?: boolean

    If the restriction should be hidden by geometry in front of it. (default: false)

    id?: string

    The id of the restriction.

    origin?: vec3

    The origin of the plane.

    vec3.fromValues(0, 0, 0)
    priority?: number

    The priority of the restriction.

    rotation?: { angle: number; axis: vec3 }

    The rotation of the object after the restriction is applied.

    vector_u?: vec3

    Vector U of the plane with the cross product of vector_u and vector_v the normal of the plane can be calculated

    vector_v?: vec3

    Vector V of the plane with the cross product of vector_u and vector_v the normal of the plane can be calculated

    Settings

    Member Visibility

    On This Page

    Properties