Viewer - Drawing Tools
    Preparing search index...

    Interface GeometryRestrictionProperties

    interface GeometryRestrictionProperties {
        nodes: ITreeNode[];
        type: RESTRICTION_TYPE;
        createHelperObjects?: boolean;
        gridSize?: number;
        hideable?: boolean;
        id?: string;
        priority?: number;
        radius?: number;
        rotation?: { angle: number; axis: vec3 };
        snapToEdges?: boolean;
        snapToEdgesRadius?: number;
        snapToFaces?: boolean;
        snapToVertices?: boolean;
        snapToVerticesRadius?: number;
        wireframe?: boolean;
        wireframeColor?: string;
        wireframeDepthTest?: boolean;
        wireframePointSize?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    nodes type createHelperObjects? gridSize? hideable? id? priority? radius? rotation? snapToEdges? snapToEdgesRadius? snapToFaces? snapToVertices? snapToVerticesRadius? wireframe? wireframeColor? wireframeDepthTest? wireframePointSize?

    Properties

    nodes: ITreeNode[]

    The nodes to restrict the interaction to.

    type: RESTRICTION_TYPE

    Type of the restriction

    createHelperObjects?: boolean

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

    gridSize?: number

    Spacing of a snap grid, in world units.

    When set, point and line picking covers a whole cell. A radius smaller than half the cell diagonal otherwise leaves gaps where the cursor cannot place a point.

    hideable?: boolean

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

    id?: string

    The id of the restriction.

    priority?: number

    The priority of the restriction.

    radius?: number

    The radius in which the restriction should snap. (default: undefined) Overrides the snapToVerticesRadius and snapToEdgesRadius if defined.

    For a point or line grid this is also the world-space pick radius.

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

    The rotation of the object after the restriction is applied.

    snapToEdges?: boolean

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

    snapToEdgesRadius?: number

    The radius in which the restriction should snap to edges. (default: 2.5% of the scene bounding sphere radius in screen space)

    snapToFaces?: boolean

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

    snapToVertices?: boolean

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

    snapToVerticesRadius?: number

    The radius in which the restriction should snap to vertices. (default: 2.5% of the scene bounding sphere radius in screen space)

    wireframe?: boolean

    If the geometry should be displayed as wireframe.

    wireframeColor?: string

    The color of the wireframe.

    wireframeDepthTest?: boolean

    If the wireframe should be rendered with depth test. (default: false)

    wireframePointSize?: number

    The point size of the wireframe if the geometry contains points. (default: as defined in the viewport settings)

    Settings

    Member Visibility

    On This Page

    Properties