Options
All
  • Public
  • Public/Protected
  • All
Menu

Viewer

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

DraggingParameterValue

DraggingParameterValue: { objects: { name: string; restrictionId: string; transformation: number[]; dragAnchorId?: string }[] }

Type declaration

  • objects: { name: string; restrictionId: string; transformation: number[]; dragAnchorId?: string }[]

DrawingParameterValue

DrawingParameterValue: { points: number[][] }

Type declaration

  • points: number[][]

EXPORT_TYPE

EXPORT_TYPE: typeof EXPORT_TYPE[keyof typeof EXPORT_TYPE]

EventResponseMapping

EventResponseMapping: { camera.end: ICameraEvent; camera.move: ICameraEvent; camera.start: ICameraEvent; output.updated: IOutputEvent; parameter.sessionValueChanged: IParameterEvent; parameter.valueChanged: IParameterEvent; rendering.beautyRenderingFinished: IRenderingEvent; scene.boundingBoxChange: ISceneEvent; scene.boundingBoxEmpty: ISceneEvent; session.closed: ISessionEvent; session.created: ISessionEvent; session.customized: ISessionEvent; session.initialOutputsLoaded: ISessionEvent; session.sdtfDelayedLoaded: ISessionEvent; task.cancel: ITaskEvent; task.end: ITaskEvent; task.process: ITaskEvent; task.start: ITaskEvent; viewport.busy.off: IViewportEvent; viewport.busy.on: IViewportEvent; viewport.closed: IViewportEvent; viewport.created: IViewportEvent; viewport.hidden: IViewportEvent; viewport.settingsLoaded: IViewportEvent; viewport.updated: IViewportEvent; viewport.visible: IViewportEvent }

Definition of the event response mapping. This mapping is used to map the event type to the corresponding event interface.

Type declaration

GumballParameterValue

GumballParameterValue: { names: string[]; transformations: number[][] }

Type declaration

  • names: string[]
  • transformations: number[][]

IAmbientLightApi

IAmbientLightApi: ILightApi

The api for an ambient light. An ambient light can be created by calling the addAmbientLight method.

IDrawingParameterApi

IDrawingParameterApi: IDrawingParameterSettings

IMapDataProperties

IMapDataProperties: IMapDataPropertiesGeneric<HTMLImageElement | ArrayBuffer>

IMapDataPropertiesDefinition

IMapDataPropertiesDefinition: Partial<IMapDataPropertiesGeneric<HTMLImageElement | ArrayBuffer | string>> | string

IMaterialAbstractDataProperties

IMaterialAbstractDataProperties: Partial<IMaterialAbstractDataPropertiesGeneric<IMapData>>

IMaterialAbstractDataPropertiesDefinition

IMaterialAbstractDataPropertiesDefinition: Partial<IMaterialAbstractDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialBasicLineDataProperties

IMaterialBasicLineDataProperties: IMaterialAbstractDataProperties

IMaterialBasicLineDataPropertiesDefinition

IMaterialBasicLineDataPropertiesDefinition: IMaterialAbstractDataPropertiesDefinition

IMaterialGemDataProperties

IMaterialGemDataProperties: Partial<IMaterialGemDataPropertiesGeneric<IMapData>>

IMaterialGemDataPropertiesDefinition

IMaterialGemDataPropertiesDefinition: Partial<IMaterialGemDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialLambertDataProperties

IMaterialLambertDataProperties: Partial<IMaterialLambertDataPropertiesGeneric<IMapData>>

IMaterialLambertDataPropertiesDefinition

IMaterialLambertDataPropertiesDefinition: Partial<IMaterialLambertDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialMultiPointDataProperties

IMaterialMultiPointDataProperties: Partial<IMaterialMultiPointDataPropertiesGeneric<IMapData>>

IMaterialMultiPointDataPropertiesDefinition

IMaterialMultiPointDataPropertiesDefinition: Partial<IMaterialMultiPointDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialPhongDataProperties

IMaterialPhongDataProperties: Partial<IMaterialPhongDataPropertiesGeneric<IMapData>>

IMaterialPhongDataPropertiesDefinition

IMaterialPhongDataPropertiesDefinition: Partial<IMaterialPhongDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialPointDataProperties

IMaterialPointDataProperties: Partial<IMaterialPointDataPropertiesGeneric<IMapData>>

IMaterialPointDataPropertiesDefinition

IMaterialPointDataPropertiesDefinition: Partial<IMaterialPointDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialShadowDataProperties

IMaterialShadowDataProperties: IMaterialAbstractDataProperties

IMaterialShadowDataPropertiesDefinition

IMaterialShadowDataPropertiesDefinition: IMaterialAbstractDataPropertiesDefinition

IMaterialSpecularGlossinessDataProperties

IMaterialSpecularGlossinessDataProperties: Partial<IMaterialSpecularGlossinessDataPropertiesGeneric<IMapData>>

IMaterialSpecularGlossinessDataPropertiesDefinition

IMaterialSpecularGlossinessDataPropertiesDefinition: Partial<IMaterialSpecularGlossinessDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialStandardDataProperties

IMaterialStandardDataProperties: Partial<IMaterialStandardDataPropertiesGeneric<IMapData>>

IMaterialStandardDataPropertiesDefinition

IMaterialStandardDataPropertiesDefinition: Partial<IMaterialStandardDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IMaterialUnlitDataProperties

IMaterialUnlitDataProperties: Partial<IMaterialUnlitDataPropertiesGeneric<IMapData>>

IMaterialUnlitDataPropertiesDefinition

IMaterialUnlitDataPropertiesDefinition: Partial<IMaterialUnlitDataPropertiesGeneric<IMapDataPropertiesDefinition>>

IRenderingEvent

IRenderingEvent: IViewportEvent

Definition of the rendering event. These events are sent for rendering specific events (EVENTTYPE_RENDERING).

InteractionParameterSettingsType

InteractionParameterSettingsType: "selection" | "gumball" | "dragging"

MainEventTypes

MainEventTypes: typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_PARAMETER | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_GUMBALL | typeof EVENTTYPE_DRAWING_TOOLS | typeof EVENTTYPE_TASK

PARAMETER_TYPE

PARAMETER_TYPE: typeof PARAMETER_TYPE[keyof typeof PARAMETER_TYPE]

PARAMETER_VISUALIZATION

PARAMETER_VISUALIZATION: typeof PARAMETER_VISUALIZATION[keyof typeof PARAMETER_VISUALIZATION]

SDTF_TYPEHINT

SDTF_TYPEHINT: typeof SDTF_TYPEHINT[keyof typeof SDTF_TYPEHINT]

SelectionParameterValue

SelectionParameterValue: { names: string[] }

Type declaration

  • names: string[]

SessionCreationDefinition

SessionCreationDefinition: { modelViewUrl: string; allowOutputLoading?: boolean; excludeViewports?: string[]; guid?: string; id?: string; ignoreUnknownParams?: boolean; initialParameterValues?: {}; jwtToken?: string; loadOutputs?: boolean; loadSdtf?: boolean; modelStateId?: string; modelStateValidationMode?: string; throwOnCustomizationError?: boolean; ticket?: string; waitForOutputs?: boolean }

Type declaration

  • modelViewUrl: string

    The modelViewUrl of the ShapeDiver Geometry Backend hosting the model.

  • Optional allowOutputLoading?: boolean

    Option to allow the outputs to be loaded, or to prevent them from being loaded. (default: true)

  • Optional excludeViewports?: string[]

    Option to exclude some viewports from the start. Can be accessed via {@link ISession.excludeViewports}.

  • Optional guid?: string

    The geometry backend model id (guid). This identifies the model on the Geometry Backend. A jwtToken is needed for authentication. If no guid was provided, a ticket has to be provided instead.

  • Optional id?: string

    The unique identifier of the session that was specified or automatically chosen on creation of the session.

  • Optional ignoreUnknownParams?: boolean

    Option to allow relaxed validation of parameter identifiers. When set to true, unrecognized parameters will be ignored rather than causing an error. (default: false)

  • Optional initialParameterValues?: {}

    The initial set of parameter values to use. Map from parameter id to parameter value. The default value will be used for any parameter not specified.

    • [key: string]: string
  • Optional jwtToken?: string

    The JWT used for authorizing API calls to the Geometry Backend.

  • Optional loadOutputs?: boolean

    Option to load the outputs, or not load them until the first call of {@link ISession.customize}. (default: true)

  • Optional loadSdtf?: boolean

    Option to load the SDTF data. The data is not loaded by default as it can be quite large. (default: false)

  • Optional modelStateId?: string

    The optional model state id to use for the session. If not provided, no model state will be loaded.

  • Optional modelStateValidationMode?: string

    The optional model state validation mode to use for the session. If not provided, the default validation mode of the Geometry SDK will be used.

  • Optional throwOnCustomizationError?: boolean

    Option to throw an error if parts of a customization failed. (default: false)

  • Optional ticket?: string

    The ticket for direct embedding of the model represented by the session. This identifies the model on the Geometry Backend. If no ticket was provided, a guid has to be provided instead.

  • Optional waitForOutputs?: boolean

    Option to wait for the outputs to be loaded, or return immediately after creation of the session. (default: true)

ShapeDiverGeometryBackendResponseErrorType

ShapeDiverGeometryBackendResponseErrorType: typeof ShapeDiverGeometryBackendResponseErrorType[keyof typeof ShapeDiverGeometryBackendResponseErrorType]

ViewportCreationDefinition

ViewportCreationDefinition: { branding?: { backgroundColor?: string; busyModeDisplay?: BUSY_MODE_DISPLAY; busyModeSpinner?: string; logo?: string | null; spinnerPositioning?: SPINNER_POSITIONING }; canvas?: HTMLCanvasElement; flags?: {}; id?: string; sessionSettingsId?: string; sessionSettingsMode?: SESSION_SETTINGS_MODE; visibility?: VISIBILITY_MODE; visibilitySessionIds?: string[] }

Type declaration

  • Optional branding?: { backgroundColor?: string; busyModeDisplay?: BUSY_MODE_DISPLAY; busyModeSpinner?: string; logo?: string | null; spinnerPositioning?: SPINNER_POSITIONING }

    The branding options of the viewport.

    • Optional backgroundColor?: string

      Optional background color to show while the viewport is hidden, can include alpha channel. A default color will be used if none is provided.

    • Optional busyModeDisplay?: BUSY_MODE_DISPLAY

      The mode used to indicate that the viewport is busy. (default: BUSY_MODE_DISPLAY.SPINNER) Whenever the busy mode gets toggled, the events EVENTTYPE_VIEWPORT.BUSY_MODE_ON and EVENTTYPE_VIEWPORT.BUSY_MODE_OFF will be emitted.

    • Optional busyModeSpinner?: string

      Optional URL to a logo to be displayed while the viewport is in busy mode. A default logo will be used if none is provided. The positioning of the spinner can be influenced via SPINNER_POSITIONING.

    • Optional logo?: string | null

      Optional URL to a logo to be displayed while the viewport is hidden. A default logo will be used if none is provided. Supply null to display no logo at all.

    • Optional spinnerPositioning?: SPINNER_POSITIONING

      Where the spinner that is specified by BUSY_MODE_DISPLAY is displayed on the screen. (default: BUSY_MODE_DISPLAY.BOTTOM_RIGHT)

  • Optional canvas?: HTMLCanvasElement

    The canvas element in which the viewport should be created, it is encourage to provide one. If none was provided, a canvas will be created.

  • Optional flags?: {}

    Optional flags that should be initially set on the viewport. The key is the token that is used to identify the flag, and the value is the type of the flag.

  • Optional id?: string

    The unique identifier of the session that was specified or automatically chosen on creation of the viewport.

  • Optional sessionSettingsId?: string

    The id of the session of which the settings should be used. Only works when sessionSettingsMode is set to {@link SESSION_SETTINGS_MODE.SESSION}.

  • Optional sessionSettingsMode?: SESSION_SETTINGS_MODE

    The mode in which settings should be applied. (default: SESSION_SETTINGS_MODE.FIRST)

  • Optional visibility?: VISIBILITY_MODE

    The initial visibility of the viewport. (default: VISIBILITY_MODE.SESSION)

  • Optional visibilitySessionIds?: string[]

    The ids of the sessions that should be displayed in the viewport. This only is considered if the visibility is set to VISIBILITY_MODE.SESSIONS. It's recommended that with this workflow, the sessionSettingsMode is set to {@link SESSION_SETTINGS_MODE.SESSION} and a sessionSettingsId is provided.

Variables

Const EVENTTYPE

EVENTTYPE: { CAMERA: typeof EVENTTYPE_CAMERA; DRAWING_TOOLS: typeof EVENTTYPE_DRAWING_TOOLS; GUMBALL: typeof EVENTTYPE_GUMBALL; INTERACTION: typeof EVENTTYPE_INTERACTION; OUTPUT: typeof EVENTTYPE_OUTPUT; PARAMETER: typeof EVENTTYPE_PARAMETER; RENDERING: typeof EVENTTYPE_RENDERING; SCENE: typeof EVENTTYPE_SCENE; SESSION: typeof EVENTTYPE_SESSION; TASK: typeof EVENTTYPE_TASK; VIEWPORT: typeof EVENTTYPE_VIEWPORT }

Definition of the event types. These types are used to identify the type of an event in an event object IEvent. The EventResponseMapping is used to map the event type to the corresponding event interface.

Type declaration

Const EXPORT_TYPE

EXPORT_TYPE: { DOWNLOAD: "download"; EMAIL: "email"; SHAPEWAYS: "shapeways"; UNKNOWN: "unknown" }

Type declaration

  • Readonly DOWNLOAD: "download"
  • Readonly EMAIL: "email"
  • Readonly SHAPEWAYS: "shapeways"
  • Readonly UNKNOWN: "unknown"

Const IDraggingParameterJsonSchema

IDraggingParameterJsonSchema: z.ZodObject<{ props: z.ZodObject<{ draggingColor: z.ZodOptional<z.ZodString>; objects: z.ZodOptional<z.ZodArray<z.ZodObject<{ dragAnchors: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; position: z.ZodArray<z.ZodNumber, "many">; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>> }, "strip", z.ZodTypeAny, { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }, { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }>, "many">>; dragOrigin: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>; nameFilter: z.ZodString; restrictions: z.ZodArray<z.ZodString, "many"> }, "strip", z.ZodTypeAny, { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }, { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }>, "many">>; restrictions: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">>, "many">> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }, { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }>; type: z.ZodLiteral<"dragging"> }, "strip", z.ZodTypeAny, { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }; type: "dragging" }>

Const IDrawingParameterJsonSchema

IDrawingParameterJsonSchema: z.ZodObject<{ general: z.ZodOptional<z.ZodObject<{ options: z.ZodOptional<z.ZodObject<{ showDistanceLabels: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; showPointLabels: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; snapToEdges: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; snapToFaces: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; snapToVertices: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }, { showDistanceLabels?: unknown; showPointLabels?: unknown; snapToEdges?: unknown; snapToFaces?: unknown; snapToVertices?: unknown }>>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }, { options?: { showDistanceLabels?: unknown; showPointLabels?: unknown; snapToEdges?: unknown; snapToFaces?: unknown; snapToVertices?: unknown }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }>>; geometry: z.ZodOptional<z.ZodObject<{ autoClose: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; close: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; maxPoints: z.ZodOptional<z.ZodNumber>; minPoints: z.ZodOptional<z.ZodNumber>; mode: z.ZodEnum<["points", "lines"]>; strictMinMaxPoints: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { mode: "points" | "lines"; autoClose?: boolean; close?: boolean; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: boolean }, { mode: "points" | "lines"; autoClose?: unknown; close?: unknown; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: unknown }>>; restrictions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">> }, "strip", z.ZodTypeAny, { general?: { options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: boolean; close?: boolean; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: boolean }; restrictions?: any[] }, { general?: { options?: { showDistanceLabels?: unknown; showPointLabels?: unknown; snapToEdges?: unknown; snapToFaces?: unknown; snapToVertices?: unknown }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: unknown; close?: unknown; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: unknown }; restrictions?: any[] }>

Const IGumballParameterJsonSchema

IGumballParameterJsonSchema: z.ZodObject<{ props: z.ZodObject<{ enableRotation: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableRotationAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; enableScaling: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableScalingAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; enableTranslation: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableTranslationAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; nameFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; scale: z.ZodOptional<z.ZodNumber>; selectionColor: z.ZodOptional<z.ZodString>; space: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"local">, z.ZodLiteral<"world">]>> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }, { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }>; type: z.ZodLiteral<"gumball"> }, "strip", z.ZodTypeAny, { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }, { props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }>

Const IInteractionParameterJsonSchema

IInteractionParameterJsonSchema: z.ZodUnion<[z.ZodUnion<[z.ZodObject<{ props: z.ZodObject<{ maximumSelection: z.ZodOptional<z.ZodNumber>; minimumSelection: z.ZodOptional<z.ZodNumber>; nameFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; selectionColor: z.ZodOptional<z.ZodString> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }, { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }>; type: z.ZodLiteral<"selection"> }, "strip", z.ZodTypeAny, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }, { props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }>, z.ZodObject<{ props: z.ZodObject<{ enableRotation: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableRotationAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; enableScaling: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableScalingAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; enableTranslation: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; enableTranslationAxes: z.ZodOptional<z.ZodObject<{ x: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; y: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; z: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown> }, "strip", z.ZodTypeAny, { x?: boolean; y?: boolean; z?: boolean }, { x?: unknown; y?: unknown; z?: unknown }>>; nameFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; scale: z.ZodOptional<z.ZodNumber>; selectionColor: z.ZodOptional<z.ZodString>; space: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"local">, z.ZodLiteral<"world">]>> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }, { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }>; type: z.ZodLiteral<"gumball"> }, "strip", z.ZodTypeAny, { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }, { props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }>]>, z.ZodObject<{ props: z.ZodObject<{ draggingColor: z.ZodOptional<z.ZodString>; objects: z.ZodOptional<z.ZodArray<z.ZodObject<{ dragAnchors: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; position: z.ZodArray<z.ZodNumber, "many">; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>> }, "strip", z.ZodTypeAny, { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }, { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }>, "many">>; dragOrigin: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>; nameFilter: z.ZodString; restrictions: z.ZodArray<z.ZodString, "many"> }, "strip", z.ZodTypeAny, { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }, { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }>, "many">>; restrictions: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">>, "many">> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }, { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }>; type: z.ZodLiteral<"dragging"> }, "strip", z.ZodTypeAny, { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectOutputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: z.objectInputType<{ id: z.ZodString; rotation: z.ZodOptional<z.ZodObject<{ angle: z.ZodNumber; axis: z.ZodArray<z.ZodNumber, "many"> }, "strip", z.ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: z.ZodString }, z.ZodTypeAny, "passthrough">[] }; type: "dragging" }>]>

Const ISelectionParameterJsonSchema

ISelectionParameterJsonSchema: z.ZodObject<{ props: z.ZodObject<{ maximumSelection: z.ZodOptional<z.ZodNumber>; minimumSelection: z.ZodOptional<z.ZodNumber>; nameFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; selectionColor: z.ZodOptional<z.ZodString> } & { hover: z.ZodEffects<z.ZodOptional<z.ZodBoolean>, boolean | undefined, unknown>; hoverColor: z.ZodOptional<z.ZodString>; prompt: z.ZodOptional<z.ZodObject<{ activeText: z.ZodOptional<z.ZodString>; activeTitle: z.ZodOptional<z.ZodString>; inactiveTitle: z.ZodOptional<z.ZodString> }, "strip", z.ZodTypeAny, { activeText?: string; activeTitle?: string; inactiveTitle?: string }, { activeText?: string; activeTitle?: string; inactiveTitle?: string }>> }, "strip", z.ZodTypeAny, { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }, { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }>; type: z.ZodLiteral<"selection"> }, "strip", z.ZodTypeAny, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }, { props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }>

Const PARAMETER_TYPE

PARAMETER_TYPE: { BOOL: "Bool"; COLOR: "Color"; DRAWING: "Drawing"; EVEN: "Even"; FILE: "File"; FLOAT: "Float"; INT: "Int"; INTERACTION: "Interaction"; ODD: "Odd"; STRING: "String"; STRINGLIST: "StringList"; S_BITMAP: "sBitmap"; S_BOOL: "sBool"; S_BOX: "sBox"; S_BREP: "sBrep"; S_CIRCLE: "sCircle"; S_COLOR: "sColor"; S_CURVE: "sCurve"; S_DOMAIN: "sDomain"; S_DOMAIN_2D: "sDomain2D"; S_INTEGER: "sInteger"; S_LINE: "sLine"; S_MESH: "sMesh"; S_NUMBER: "sNumber"; S_PLANE: "sPlane"; S_POINT: "sPoint"; S_RECTANGLE: "sRectangle"; S_STRING: "sString"; S_SUBDIV: "sSubdiv"; S_SURFACE: "sSurface"; S_TIME: "sTime"; S_VECTOR: "sVector"; TIME: "Time"; UNKNOWN: "unknown" }

Type declaration

  • Readonly BOOL: "Bool"
  • Readonly COLOR: "Color"
  • Readonly DRAWING: "Drawing"
  • Readonly EVEN: "Even"
  • Readonly FILE: "File"
  • Readonly FLOAT: "Float"
  • Readonly INT: "Int"
  • Readonly INTERACTION: "Interaction"
  • Readonly ODD: "Odd"
  • Readonly STRING: "String"
  • Readonly STRINGLIST: "StringList"
  • Readonly S_BITMAP: "sBitmap"
  • Readonly S_BOOL: "sBool"
  • Readonly S_BOX: "sBox"
  • Readonly S_BREP: "sBrep"
  • Readonly S_CIRCLE: "sCircle"
  • Readonly S_COLOR: "sColor"
  • Readonly S_CURVE: "sCurve"
  • Readonly S_DOMAIN: "sDomain"
  • Readonly S_DOMAIN_2D: "sDomain2D"
  • Readonly S_INTEGER: "sInteger"
  • Readonly S_LINE: "sLine"
  • Readonly S_MESH: "sMesh"
  • Readonly S_NUMBER: "sNumber"
  • Readonly S_PLANE: "sPlane"
  • Readonly S_POINT: "sPoint"
  • Readonly S_RECTANGLE: "sRectangle"
  • Readonly S_STRING: "sString"
  • Readonly S_SUBDIV: "sSubdiv"
  • Readonly S_SURFACE: "sSurface"
  • Readonly S_TIME: "sTime"
  • Readonly S_VECTOR: "sVector"
  • Readonly TIME: "Time"
  • Readonly UNKNOWN: "unknown"

Const PARAMETER_VISUALIZATION

PARAMETER_VISUALIZATION: { BUTTON: "button"; CALENDAR: "calendar"; CHECKLIST: "checklist"; CLOCK: "clock"; CYCLE: "cycle"; DIAL: "dial"; DROPDOWN: "dropdown"; GEOMETRY: "geometry"; IMAGE: "image"; SEQUENCE: "sequence"; SLIDER: "slider"; SWATCH: "swatch"; TEXT: "text"; TOGGLE: "toggle"; UNKNOWN: "unknown" }

Type declaration

  • Readonly BUTTON: "button"
  • Readonly CALENDAR: "calendar"
  • Readonly CHECKLIST: "checklist"
  • Readonly CLOCK: "clock"
  • Readonly CYCLE: "cycle"
  • Readonly DIAL: "dial"
  • Readonly DROPDOWN: "dropdown"
  • Readonly GEOMETRY: "geometry"
  • Readonly IMAGE: "image"
  • Readonly SEQUENCE: "sequence"
  • Readonly SLIDER: "slider"
  • Readonly SWATCH: "swatch"
  • Readonly TEXT: "text"
  • Readonly TOGGLE: "toggle"
  • Readonly UNKNOWN: "unknown"

Const SDTF_TYPEHINT

SDTF_TYPEHINT: { BOOLEAN: SdtfPrimitiveTypeHintName.BOOLEAN; CHAR: SdtfPrimitiveTypeHintName.CHAR; COLOR: SdtfPrimitiveTypeHintName.COLOR; DATA: SdtfPrimitiveTypeHintName.DATA; DECIMAL: SdtfPrimitiveTypeHintName.DECIMAL; DOUBLE: SdtfPrimitiveTypeHintName.DOUBLE; GEOMETRY_ARC: SdtfGeometryTypeHintName.GEOMETRY_ARC; GEOMETRY_BOUNDING_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOUNDING_BOX; GEOMETRY_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOX; GEOMETRY_CIRCLE: SdtfGeometryTypeHintName.GEOMETRY_CIRCLE; GEOMETRY_COMPLEX: SdtfGeometryTypeHintName.GEOMETRY_COMPLEX; GEOMETRY_CONE: SdtfGeometryTypeHintName.GEOMETRY_CONE; GEOMETRY_CYLINDER: SdtfGeometryTypeHintName.GEOMETRY_CYLINDER; GEOMETRY_ELLIPSE: SdtfGeometryTypeHintName.GEOMETRY_ELLIPSE; GEOMETRY_INTERVAL: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL; GEOMETRY_INTERVAL2: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL2; GEOMETRY_LINE: SdtfGeometryTypeHintName.GEOMETRY_LINE; GEOMETRY_MATRIX: SdtfGeometryTypeHintName.GEOMETRY_MATRIX; GEOMETRY_PLANE: SdtfGeometryTypeHintName.GEOMETRY_PLANE; GEOMETRY_POINT: SdtfGeometryTypeHintName.GEOMETRY_POINT; GEOMETRY_POINT2D: SdtfGeometryTypeHintName.GEOMETRY_POINT2D; GEOMETRY_POINT3D: SdtfGeometryTypeHintName.GEOMETRY_POINT3D; GEOMETRY_POINT4D: SdtfGeometryTypeHintName.GEOMETRY_POINT4D; GEOMETRY_POLYLINE: SdtfGeometryTypeHintName.GEOMETRY_POLYLINE; GEOMETRY_RAY: SdtfGeometryTypeHintName.GEOMETRY_RAY; GEOMETRY_RECTANGLE: SdtfGeometryTypeHintName.GEOMETRY_RECTANGLE; GEOMETRY_SPHERE: SdtfGeometryTypeHintName.GEOMETRY_SPHERE; GEOMETRY_TORUS: SdtfGeometryTypeHintName.GEOMETRY_TORUS; GEOMETRY_TRANSFORM: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM; GEOMETRY_TRANSFORM_LIST: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM_LIST; GEOMETRY_VECTOR: SdtfGeometryTypeHintName.GEOMETRY_VECTOR; GEOMETRY_VECTOR2D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR2D; GEOMETRY_VECTOR3D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR3D; GEOMETRY_VECTOR4D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR4D; GRASSHOPPER_PATH: SdtfGrasshopperTypeHintName.GRASSHOPPER_PATH; GUID: SdtfPrimitiveTypeHintName.GUID; IMAGE: SdtfPrimitiveTypeHintName.IMAGE; INT16: SdtfPrimitiveTypeHintName.INT16; INT32: SdtfPrimitiveTypeHintName.INT32; INT64: SdtfPrimitiveTypeHintName.INT64; INT8: SdtfPrimitiveTypeHintName.INT8; JSON: SdtfPrimitiveTypeHintName.JSON; RHINO_ARC_CURVE: SdtfRhinoTypeHintName.RHINO_ARC_CURVE; RHINO_BREP: SdtfRhinoTypeHintName.RHINO_BREP; RHINO_CURVE: SdtfRhinoTypeHintName.RHINO_CURVE; RHINO_EXTRUSION: SdtfRhinoTypeHintName.RHINO_EXTRUSION; RHINO_LINE_CURVE: SdtfRhinoTypeHintName.RHINO_LINE_CURVE; RHINO_MESH: SdtfRhinoTypeHintName.RHINO_MESH; RHINO_NURBS_CURVE: SdtfRhinoTypeHintName.RHINO_NURBS_CURVE; RHINO_NURBS_SURFACE: SdtfRhinoTypeHintName.RHINO_NURBS_SURFACE; RHINO_PLANE_SURFACE: SdtfRhinoTypeHintName.RHINO_PLANE_SURFACE; RHINO_POINT: SdtfRhinoTypeHintName.RHINO_POINT; RHINO_POLYLINE_CURVE: SdtfRhinoTypeHintName.RHINO_POLYLINE_CURVE; RHINO_POLY_CURVE: SdtfRhinoTypeHintName.RHINO_POLY_CURVE; RHINO_REV_SURFACE: SdtfRhinoTypeHintName.RHINO_REV_SURFACE; RHINO_SUBD: SdtfRhinoTypeHintName.RHINO_SUBD; RHINO_SURFACE: SdtfRhinoTypeHintName.RHINO_SURFACE; SINGLE: SdtfPrimitiveTypeHintName.SINGLE; STRING: SdtfPrimitiveTypeHintName.STRING; UINT16: SdtfPrimitiveTypeHintName.UINT16; UINT32: SdtfPrimitiveTypeHintName.UINT32; UINT64: SdtfPrimitiveTypeHintName.UINT64; UINT8: SdtfPrimitiveTypeHintName.UINT8 }

Type declaration

  • BOOLEAN: SdtfPrimitiveTypeHintName.BOOLEAN
  • CHAR: SdtfPrimitiveTypeHintName.CHAR
  • COLOR: SdtfPrimitiveTypeHintName.COLOR
  • DATA: SdtfPrimitiveTypeHintName.DATA
  • DECIMAL: SdtfPrimitiveTypeHintName.DECIMAL
  • DOUBLE: SdtfPrimitiveTypeHintName.DOUBLE
  • GEOMETRY_ARC: SdtfGeometryTypeHintName.GEOMETRY_ARC
  • GEOMETRY_BOUNDING_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOUNDING_BOX
  • GEOMETRY_BOX: SdtfGeometryTypeHintName.GEOMETRY_BOX
  • GEOMETRY_CIRCLE: SdtfGeometryTypeHintName.GEOMETRY_CIRCLE
  • GEOMETRY_COMPLEX: SdtfGeometryTypeHintName.GEOMETRY_COMPLEX
  • GEOMETRY_CONE: SdtfGeometryTypeHintName.GEOMETRY_CONE
  • GEOMETRY_CYLINDER: SdtfGeometryTypeHintName.GEOMETRY_CYLINDER
  • GEOMETRY_ELLIPSE: SdtfGeometryTypeHintName.GEOMETRY_ELLIPSE
  • GEOMETRY_INTERVAL: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL
  • GEOMETRY_INTERVAL2: SdtfGeometryTypeHintName.GEOMETRY_INTERVAL2
  • GEOMETRY_LINE: SdtfGeometryTypeHintName.GEOMETRY_LINE
  • GEOMETRY_MATRIX: SdtfGeometryTypeHintName.GEOMETRY_MATRIX
  • GEOMETRY_PLANE: SdtfGeometryTypeHintName.GEOMETRY_PLANE
  • GEOMETRY_POINT: SdtfGeometryTypeHintName.GEOMETRY_POINT
  • GEOMETRY_POINT2D: SdtfGeometryTypeHintName.GEOMETRY_POINT2D
  • GEOMETRY_POINT3D: SdtfGeometryTypeHintName.GEOMETRY_POINT3D
  • GEOMETRY_POINT4D: SdtfGeometryTypeHintName.GEOMETRY_POINT4D
  • GEOMETRY_POLYLINE: SdtfGeometryTypeHintName.GEOMETRY_POLYLINE
  • GEOMETRY_RAY: SdtfGeometryTypeHintName.GEOMETRY_RAY
  • GEOMETRY_RECTANGLE: SdtfGeometryTypeHintName.GEOMETRY_RECTANGLE
  • GEOMETRY_SPHERE: SdtfGeometryTypeHintName.GEOMETRY_SPHERE
  • GEOMETRY_TORUS: SdtfGeometryTypeHintName.GEOMETRY_TORUS
  • GEOMETRY_TRANSFORM: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM
  • GEOMETRY_TRANSFORM_LIST: SdtfGeometryTypeHintName.GEOMETRY_TRANSFORM_LIST
  • GEOMETRY_VECTOR: SdtfGeometryTypeHintName.GEOMETRY_VECTOR
  • GEOMETRY_VECTOR2D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR2D
  • GEOMETRY_VECTOR3D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR3D
  • GEOMETRY_VECTOR4D: SdtfGeometryTypeHintName.GEOMETRY_VECTOR4D
  • GRASSHOPPER_PATH: SdtfGrasshopperTypeHintName.GRASSHOPPER_PATH
  • GUID: SdtfPrimitiveTypeHintName.GUID
  • IMAGE: SdtfPrimitiveTypeHintName.IMAGE
  • INT16: SdtfPrimitiveTypeHintName.INT16
  • INT32: SdtfPrimitiveTypeHintName.INT32
  • INT64: SdtfPrimitiveTypeHintName.INT64
  • INT8: SdtfPrimitiveTypeHintName.INT8
  • JSON: SdtfPrimitiveTypeHintName.JSON
  • RHINO_ARC_CURVE: SdtfRhinoTypeHintName.RHINO_ARC_CURVE
  • RHINO_BREP: SdtfRhinoTypeHintName.RHINO_BREP
  • RHINO_CURVE: SdtfRhinoTypeHintName.RHINO_CURVE
  • RHINO_EXTRUSION: SdtfRhinoTypeHintName.RHINO_EXTRUSION
  • RHINO_LINE_CURVE: SdtfRhinoTypeHintName.RHINO_LINE_CURVE
  • RHINO_MESH: SdtfRhinoTypeHintName.RHINO_MESH
  • RHINO_NURBS_CURVE: SdtfRhinoTypeHintName.RHINO_NURBS_CURVE
  • RHINO_NURBS_SURFACE: SdtfRhinoTypeHintName.RHINO_NURBS_SURFACE
  • RHINO_PLANE_SURFACE: SdtfRhinoTypeHintName.RHINO_PLANE_SURFACE
  • RHINO_POINT: SdtfRhinoTypeHintName.RHINO_POINT
  • RHINO_POLYLINE_CURVE: SdtfRhinoTypeHintName.RHINO_POLYLINE_CURVE
  • RHINO_POLY_CURVE: SdtfRhinoTypeHintName.RHINO_POLY_CURVE
  • RHINO_REV_SURFACE: SdtfRhinoTypeHintName.RHINO_REV_SURFACE
  • RHINO_SUBD: SdtfRhinoTypeHintName.RHINO_SUBD
  • RHINO_SURFACE: SdtfRhinoTypeHintName.RHINO_SURFACE
  • SINGLE: SdtfPrimitiveTypeHintName.SINGLE
  • STRING: SdtfPrimitiveTypeHintName.STRING
  • UINT16: SdtfPrimitiveTypeHintName.UINT16
  • UINT32: SdtfPrimitiveTypeHintName.UINT32
  • UINT64: SdtfPrimitiveTypeHintName.UINT64
  • UINT8: SdtfPrimitiveTypeHintName.UINT8

Const ShapeDiverGeometryBackendResponseErrorType

ShapeDiverGeometryBackendResponseErrorType: { ASSERTION_ERROR: "SdAssertionError"; CACHE_ERROR_GENERIC: "SdCacheErrorGeneric"; CONNECTOR_ERROR: "SdConnectorError"; DATABASE_ERROR_GENERIC: "SdDatabaseErrorGeneric"; EMAILING_ERROR: "SdEmailingError"; ERROR_ENTITY_NOT_FOUND: "SdErrorEntityNotFound"; ERROR_FORBIDDEN: "SdErrorForbidden"; ERROR_GENERIC_CLIENT: "SdErrorGenericClient"; ERROR_GENERIC_INTERNAL: "SdErrorGenericInternal"; ERROR_UNAUTHORIZED: "SdErrorUnauthorized"; ILLEGAL_ARGUMENT_ERROR: "SdIllegalArgumentError"; JWT_VALIDATION_ERROR: "SdJwtValidationError"; METHOD_NOT_ALLOWED_ERROR: "SdMethodNotAllowedError"; MODEL_VALIDATION_ERROR: "SdModelValidationError"; NOT_ACCEPTABLE: "SdNotAcceptable"; NOT_FOUND_ERROR: "SdNotFoundError"; PARAMETER_VALIDATION_ERROR: "SdParameterValidationError"; RATE_LIMIT_ERROR_GENERIC: "SdRateLimitErrorGeneric"; REQUEST_TIMEOUT: "SdRequestTimeout"; REQUEST_VALIDATION_ERROR: "SdRequestValidationError"; RESOURCE_GONE_ERROR: "SdResourceGoneError"; SESSION_GONE_ERROR: "SdSessionGoneError"; SESSION_VALIDATION_ERROR: "SdSessionValidationError"; STORAGE_ERROR_GENERIC: "SdStorageErrorGeneric"; TEXTURE_URL_ERROR: "SdTextureUrlError"; TICKET_VALIDATION_ERROR: "SdTicketValidationError"; TOKEN_MISSING_ERROR: "SdTokenMissingError"; TRANSFORM_CONTENT_ARRAY_ERROR: "SdTransformContentArrayError"; UNCONFIRMED_MODEL_ERROR: "SdUnconfirmedModelError"; UNKNOWN: "" }

Type declaration

  • Readonly ASSERTION_ERROR: "SdAssertionError"
  • Readonly CACHE_ERROR_GENERIC: "SdCacheErrorGeneric"
  • Readonly CONNECTOR_ERROR: "SdConnectorError"
  • Readonly DATABASE_ERROR_GENERIC: "SdDatabaseErrorGeneric"
  • Readonly EMAILING_ERROR: "SdEmailingError"
  • Readonly ERROR_ENTITY_NOT_FOUND: "SdErrorEntityNotFound"
  • Readonly ERROR_FORBIDDEN: "SdErrorForbidden"
  • Readonly ERROR_GENERIC_CLIENT: "SdErrorGenericClient"
  • Readonly ERROR_GENERIC_INTERNAL: "SdErrorGenericInternal"
  • Readonly ERROR_UNAUTHORIZED: "SdErrorUnauthorized"
  • Readonly ILLEGAL_ARGUMENT_ERROR: "SdIllegalArgumentError"
  • Readonly JWT_VALIDATION_ERROR: "SdJwtValidationError"
  • Readonly METHOD_NOT_ALLOWED_ERROR: "SdMethodNotAllowedError"
  • Readonly MODEL_VALIDATION_ERROR: "SdModelValidationError"
  • Readonly NOT_ACCEPTABLE: "SdNotAcceptable"
  • Readonly NOT_FOUND_ERROR: "SdNotFoundError"
  • Readonly PARAMETER_VALIDATION_ERROR: "SdParameterValidationError"
  • Readonly RATE_LIMIT_ERROR_GENERIC: "SdRateLimitErrorGeneric"
  • Readonly REQUEST_TIMEOUT: "SdRequestTimeout"
  • Readonly REQUEST_VALIDATION_ERROR: "SdRequestValidationError"
  • Readonly RESOURCE_GONE_ERROR: "SdResourceGoneError"
  • Readonly SESSION_GONE_ERROR: "SdSessionGoneError"
  • Readonly SESSION_VALIDATION_ERROR: "SdSessionValidationError"
  • Readonly STORAGE_ERROR_GENERIC: "SdStorageErrorGeneric"
  • Readonly TEXTURE_URL_ERROR: "SdTextureUrlError"
  • Readonly TICKET_VALIDATION_ERROR: "SdTicketValidationError"
  • Readonly TOKEN_MISSING_ERROR: "SdTokenMissingError"
  • Readonly TRANSFORM_CONTENT_ARRAY_ERROR: "SdTransformContentArrayError"
  • Readonly UNCONFIRMED_MODEL_ERROR: "SdUnconfirmedModelError"
  • Readonly UNKNOWN: ""

Const defaultSettings

defaultSettings: { default: any; furniture: any; highPerformance: any; jewelry: any; medical: any; twoDimensional: any }

Type declaration

  • default:function
    • default(): ISettings

    • Returns ISettings

  • furniture:function
    • furniture(): ISettings

    • Returns ISettings

  • highPerformance:function
    • highPerformance(): ISettings

    • Returns ISettings

  • jewelry:function
    • jewelry(): ISettings

    • Returns ISettings

  • medical:function
    • medical(): ISettings

    • Returns ISettings

  • twoDimensional:function
    • twoDimensional(): ISettings

    • Returns ISettings

Const generalOptions

generalOptions: IGeneralOptions

General Viewer options that are used everywhere.

  • loggingLevel: The logging level that is used.
  • showMessages: Option to show/hide messages in the browser console.
  • parallelGlTFProcessing: The number of glTFs that are downloaded and processed at the same time.
  • consoleBranding: When set to false, the branding in the viewer console will be limited to a single line.
  • caching: Caching Options.

Const sceneTree

sceneTree: ITree

The scene tree that is used to store the scene. The scene tree contains a unique node and child nodes for each session, and can also be used to add your own nodes.

Const sessions

sessions: {}

The sessions that are currently being used.

Type declaration

Const version

version: string

The version of the viewer.

Const viewports

viewports: {}

The viewports that are currently being used.

Type declaration

Functions

addListener

  • Adds an event listener.

    Parameters

    Returns string

createSession

  • Create and initialize a session with a model hosted on a ShapeDiver Geometry Backend, using the provided ticket/guid and modelViewUrl. Returns a session api object allowing to control the session.

    A JWT can be specified for authorizing the API calls to the Geometry Backend. The model's settings on the Geometry Backend might require a JWT to be provided.

    By default the outputs of the model for its default parameter values will be loaded.

    An optional identifier for the session can be provided. This identifier can be used to retrieve the api object from sessions. In case no identifier is provided, a unique one will be generated.

    Parameters

    Returns Promise<ISessionApi>

createViewport

  • Create and initialize a viewport with the provided type and canvas, and return a viewport api object allowing to control it.

    An optional identifier for the viewport can be provided. This identifier can be used to retrieve the viewport object from viewports. In case no identifier is provided, a unique one will be generated.

    By default a new viewport displays the complete scene tree. Viewports can be excluded from displaying geometry for specific sessions by using the excludeViewports property of ISessionApi.

    Parameters

    Returns Promise<IViewportApi>

isARError

isDraggingParameterApi

isDrawingParameterApi

isExportApi

isFileParameterApi

isGumballParameterApi

isOutputApi

isParameterApi

isSelectionParameterApi

isSessionApi

isValid

isViewerCameraError

isViewerCustomizationError

isViewerDataProcessingError

isViewerDrawingToolsError

isViewerEnvironmentMapError

isViewerError

  • Type guard for all error types of the viewer package.

    Parameters

    • e: any

    Returns e is ShapeDiverViewerError

isViewerGeometryBackendError

isViewerGeometryBackendGenericError

isViewerGeometryBackendRequestError

isViewerGeometryBackendResponseError

isViewerInteractionError

isViewerLightError

isViewerSessionError

isViewerSettingsError

isViewerUnknownError

isViewerValidationError

isViewerViewportError

isViewerWebGLError

removeListener

  • removeListener(id: string): boolean

  • Removes an event listener.

    Parameters

    • id: string

      The id of the listener.

    Returns boolean

stringify

validateDraggingParameterSettings

  • validateDraggingParameterSettings(param: unknown): SafeParseReturnType<{ props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectInputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectOutputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }>

  • Parameters

    • param: unknown

    Returns SafeParseReturnType<{ props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectInputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectOutputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }>

validateDrawingParameterSettings

  • validateDrawingParameterSettings(param: unknown): SafeParseReturnType<{ general?: { options?: { showDistanceLabels?: unknown; showPointLabels?: unknown; snapToEdges?: unknown; snapToFaces?: unknown; snapToVertices?: unknown }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: unknown; close?: unknown; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: unknown }; restrictions?: any[] }, { general?: { options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: boolean; close?: boolean; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: boolean }; restrictions?: any[] }>

  • Parameters

    • param: unknown

    Returns SafeParseReturnType<{ general?: { options?: { showDistanceLabels?: unknown; showPointLabels?: unknown; snapToEdges?: unknown; snapToFaces?: unknown; snapToVertices?: unknown }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: unknown; close?: unknown; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: unknown }; restrictions?: any[] }, { general?: { options?: { showDistanceLabels?: boolean; showPointLabels?: boolean; snapToEdges?: boolean; snapToFaces?: boolean; snapToVertices?: boolean }; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string } }; geometry?: { mode: "points" | "lines"; autoClose?: boolean; close?: boolean; maxPoints?: number; minPoints?: number; strictMinMaxPoints?: boolean }; restrictions?: any[] }>

validateGumballParameterSettings

  • validateGumballParameterSettings(param: unknown): SafeParseReturnType<{ props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }, { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }>

  • Parameters

    • param: unknown

    Returns SafeParseReturnType<{ props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }, { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" }>

validateInteractionParameterSettings

  • validateInteractionParameterSettings(param: unknown): SafeParseReturnType<{ props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" } | { props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" } | { props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectInputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" } | { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" } | { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectOutputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }>

  • Parameters

    • param: unknown

    Returns SafeParseReturnType<{ props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" } | { props: { enableRotation?: unknown; enableRotationAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableScaling?: unknown; enableScalingAxes?: { x?: unknown; y?: unknown; z?: unknown }; enableTranslation?: unknown; enableTranslationAxes?: { x?: unknown; y?: unknown; z?: unknown }; hover?: unknown; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" } | { props: { draggingColor?: string; hover?: unknown; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectInputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" } | { props: { enableRotation?: boolean; enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableScaling?: boolean; enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }; enableTranslation?: boolean; enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }; hover?: boolean; hoverColor?: string; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; scale?: number; selectionColor?: string; space?: "local" | "world" }; type: "gumball" } | { props: { draggingColor?: string; hover?: boolean; hoverColor?: string; objects?: { nameFilter: string; restrictions: string[]; dragAnchors?: { id: string; position: number[]; rotation?: { angle: number; axis: number[] } }[]; dragOrigin?: number[] }[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; restrictions?: objectOutputType<{ id: ZodString; rotation: ZodOptional<ZodObject<{ angle: ZodNumber; axis: ZodArray<ZodNumber, "many"> }, "strip", ZodTypeAny, { angle: number; axis: number[] }, { angle: number; axis: number[] }>>; type: ZodString }, ZodTypeAny, "passthrough">[] }; type: "dragging" }>

validateSelectionParameterSettings

  • validateSelectionParameterSettings(param: unknown): SafeParseReturnType<{ props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }>

  • Parameters

    • param: unknown

    Returns SafeParseReturnType<{ props: { hover?: unknown; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }, { props: { hover?: boolean; hoverColor?: string; maximumSelection?: number; minimumSelection?: number; nameFilter?: string[]; prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }; selectionColor?: string }; type: "selection" }>