Interface InitializeModelState

initialize model state

Note: EXPERIMENTAL_clippingEnabled and visibleThroughGeometry are now part of ModelStyle

interface InitializeModelState {
    clippingPlaneTopColor?: string;
    clippingPlaneTopVisible?: boolean;
    clippingPlaneZOffset?: number;
    color?: string;
    EXPERIMENTAL_clippingEnabled?: boolean;
    interactive?: boolean;
    material?: { [name: string]: MaterialStyle };
    opacity?: number;
    rotation?: [number, number, number];
    scale?: [number, number, number];
    url?: string;
    verticalOffset?: number;
    visible?: boolean;
    visibleThroughGeometry?: boolean;
}

Properties

clippingPlaneTopColor? clippingPlaneTopVisible? clippingPlaneZOffset? color? EXPERIMENTAL_clippingEnabled? interactive? material? opacity? rotation? scale? url? verticalOffset? visible? visibleThroughGeometry?

Properties

OptionalclippingPlaneTopColor

clippingPlaneTopColor?: string

The color of the top of the clipping plane.

Optional ExperimentalclippingPlaneTopVisible

clippingPlaneTopVisible?: boolean

Whether the clipping plane is visible.

Default

true

OptionalclippingPlaneZOffset

clippingPlaneZOffset?: number

The clipping plane z offset of the model.

Default

Infinity

Optionalcolor

color?: string

Color property designed for use with @mappedin/3d-assets. Updates the accent color of 3d assets by applying the color to materials named ['Default', 'Fabric', 'Mpdn_Logo', 'Fabric_Logo']. For custom colors on non-Mappedin models, use the material property. If both the material and color properties are provided, material property updates will take higher precedence than color property updates.

OptionalEXPERIMENTAL_clippingEnabled

EXPERIMENTAL_clippingEnabled?: boolean

When true, enables clipping plane functionality for this model. This cannot be changed at runtime.

Note: This will de-optimize the model by disabling instancing.

Default

false

Optionalinteractive

interactive?: boolean

Whether the model is interactive, which means it can be hovered over and clicked on.

Example

	renderer.on('click', ({ geometry }) => {});

Optionalmaterial

material?: { [name: string]: MaterialStyle }

Change material state by name

Example

mapView.Models.add(
  { target: new Coordinate(45, -75) },
  {
    url: 'bed.glb',
    materials: {
      Default: {
        color: MAPPEDIN_COLOR.orange,
      },
    },
  },
);

Optionalopacity

opacity?: number

Opacity of the model group.

Optionalrotation

rotation?: [number, number, number]

The rotation of the model in degrees [x, y, z].

  • x: Rotation around x-axis (pitch)
  • y: Rotation around y-axis (yaw)
  • z: Rotation around z-axis (roll), where z points up

Rotations are applied in order: x, then y, then z. 0 degrees means the model faces north (or the parent group's forward direction). Positive rotations follow the right-hand rule.

Optionalscale

scale?: [number, number, number]

The scale of the model in [x, y, z]

Optionalurl

url?: string

Model's URL. Can be based64 inlined url.

OptionalverticalOffset

verticalOffset?: number

Vertical offset of the model in meters off the floor.

Deprecated

Use position.verticalOffset instead by passing a Coordinate with the desired verticalOffset to updateState(model, { position: coordinate }). This property will be removed in a future version.

Optionalvisible

visible?: boolean

Visiiblity of the model group

OptionalvisibleThroughGeometry

visibleThroughGeometry?: boolean

Whether the model should be visible through geometry.

Note: When set to true at creation time, this will de-optimize the model by disabling instancing.

Settings

Member Visibility

On This Page

Properties