Viewer
    Preparing search index...

    Interface IGeometryRestrictionDefinition

    interface IGeometryRestrictionDefinition {
        id: string;
        nameFilter: string[];
        type: "geometry";
        gridSize?: number;
        radius?: number;
        rotation?: Rotation;
        snapToEdges?: boolean;
        snapToFaces?: boolean;
        snapToVertices?: boolean;
        wireframe?: boolean;
        wireframeColor?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id: string

    The unique id of the restriction.

    nameFilter: string[]

    The name filter for the objects that can be dragged with the defined settings.

    type: "geometry"

    The type of the restriction.

    gridSize?: number

    Spacing of a snap grid, in world units. Point and line picking covers at least one cell of this size.

    radius?: number

    World-space pick radius for points and lines. Also the vertex and edge snap radius when snapping on a mesh.

    rotation?: Rotation

    Optional rotation of the restriction.

    snapToEdges?: boolean

    If the restriction should snap to edges. (default: true)

    snapToFaces?: boolean

    If the restriction should snap to faces. (default: true)

    snapToVertices?: boolean

    If the restriction should snap to vertices. (default: true)

    wireframe?: boolean

    If the restriction should be displayed as a wireframe line.

    wireframeColor?: string

    The color of the wireframe.