Interface IRestriction

interface IRestriction {
    enabled: boolean;
    hideable: boolean;
    id: string;
    priority: number;
    rotation: { angle: number; axis: vec3 };
    showVisualization: boolean;
    snapRestrictions: { [key: string]: ISnapRestriction };
    type: RESTRICTION_TYPE;
    rayTrace(
        ray: IRay,
        metaData?: RestrictionMetaData,
    ): RestrictionResult | undefined;
    removeVisualization(): void;
}

Index

Properties

enabled hideable id priority rotation showVisualization snapRestrictions type

Methods

rayTrace removeVisualization

Properties

enabled

enabled: boolean

hideable

hideable: boolean

`Readonly`id

id: string

`Readonly`priority

priority: number

rotation

rotation: { angle: number; axis: vec3 }

showVisualization

showVisualization: boolean

`Readonly`snapRestrictions

snapRestrictions: { [key: string]: ISnapRestriction }

`Readonly`type

type: RESTRICTION_TYPE

Methods

rayTrace

rayTrace(
ray: IRay,
metaData?: RestrictionMetaData,
): RestrictionResult | undefined
Ray trace the restriction. If the ray does not intersect the restriction, the method returns undefined.
Parameters
- ray: IRay
  The ray to trace.
- OptionalmetaData: RestrictionMetaData
  The meta data of the ray.
Returns RestrictionResult | undefined
The intersection point of the ray with the restriction.

removeVisualization

removeVisualization(): void
Remove the visualization of the restriction.

Returns void