Namespace: reearth.visualizer

Methods:

camera

The description for camera can be found here.

engine

The name of the engine currently used which is a string. An example value would be "cesium"

property

Function that returns a SceneProperty with values outlined below:

type SceneProperty = {
  default?: { // Default settings for the scene, including camera, ground entrance permission, skybox visibility, background color, ion setting, scene mode (defaulting to scene3d), and virtual reality mode.
    camera?: Camera; // Specifies the camera configuration for the scene.
    allowEnterGround?: boolean; // Determines whether entering the ground is allowed in the scene.
    skybox?: boolean; // Indicates whether a skybox should be displayed in the scene.
    bgcolor?: string; // Defines the background color of the scene.
    ion?: string; // Represents a setting related to ion in the scene.
    sceneMode?: SceneMode; // Specifies the scene mode, defaulting to "scene3d".
    vr?: boolean; // Indicates whether virtual reality mode is enabled in the scene.
  } & TerrainProperty; 
  cameraLimiter?: { // Parameters for limiting camera movement, including enabling/disabling the limiter, showing helper visuals, defining the target area, width, and length.
    cameraLimitterEnabled?: boolean; // Indicates whether the camera limiter is enabled or disabled.
    cameraLimitterShowHelper?: boolean; // Determines whether helper visuals for the camera limiter are shown.
    cameraLimitterTargetArea?: Camera; // Specifies the target area for the camera limiter.
    cameraLimitterTargetWidth?: number; // Defines the width of the target area for the camera limiter.
    cameraLimitterTargetLength?: number; // Defines the length of the target area for the camera limiter.
  };
  indicator?: { // Configuration for scene indicators, specifying the type, optional image, and its scaling.
    indicator_type: IndicatorTypes; // Specifies the type of indicator used in the scene, such as arrows, circles, etc.
    indicator_image?: string; // Optional. Specifies an image to be used as the indicator.
    indicator_image_scale?: number; // Optional. Determines the scaling factor applied to the indicator image.
  };
  tiles?: { // Array of tile properties, each containing an ID, type, URL, maximum and minimum levels, and opacity.
    id: string; // Unique identifier for the tile.
    tile_type?: string; // Optional. Specifies the type of tile.
    tile_url?: string; // Optional. URL pointing to the location of the tile.
    tile_maxLevel?: number; // Optional. Maximum level of detail for the tile.
    tile_minLevel?: number; // Optional. Minimum level of detail for the tile.
    tile_opacity?: number; // Optional. Opacity level of the tile.
  }[];
  terrain?: TerrainProperty; // Properties related to the terrain of the scene.
  atmosphere?: { // Settings controlling atmospheric effects, such as sunlight, lighting, ground and sky atmosphere, shadows, fog, density, brightness, hue, and saturation shifts.
    enable_sun?: boolean; // Specifies whether the sun is enabled in the atmosphere.
    enable_lighting?: boolean; // Indicates whether lighting effects are enabled in the atmosphere.
    ground_atmosphere?: boolean; // Determines whether there is an atmosphere effect near the ground.
    sky_atmosphere?: boolean; // Specifies whether there is an atmosphere effect in the sky.
    shadows?: boolean; // Indicates whether shadows are enabled in the atmosphere.
    fog?: boolean; // Specifies whether fog effects are enabled in the atmosphere.
    fog_density?: number; // Determines the density of the fog in the atmosphere.
    brightness_shift?: number; // Shifts the overall brightness of the atmosphere.
    hue_shift?: number; // Shifts the hue of the atmosphere.
    surturation_shift?: number; // Shifts the saturation of the atmosphere.
  };
  timeline?: { // Parameters for scene timeline, including animation, visibility, current time, start and stop times, step type (rate or fixed), multiplier, step size, and range type (unbounded, clamped, or bounced).
    animation?: boolean; // Specifies whether animation is enabled in the scene timeline.
    visible?: boolean; // Determines the visibility of the timeline.
    current?: string; // Represents the current time in the timeline.
    start?: string; // Defines the start time of the timeline.
    stop?: string; // Defines the stop time of the timeline.
    stepType?: "rate" | "fixed"; // Specifies the type of step in the timeline, either "rate" or "fixed".
    multiplier?: number; // Multiplier applied to the step size in the timeline.
    step?: number; // Defines the step size in the timeline.
    rangeType?: "unbounded" | "clamped" | "bounced"; // Specifies the range type of the timeline, whether "unbounded", "clamped", or "bounced".
  };
  googleAnalytics?: { // Integration with Google Analytics, enabling tracking with a specified tracking ID.
    enableGA?: boolean; // A boolean value indicating whether Google Analytics tracking is enabled.
    trackingId?: string; // A string representing the unique tracking ID used for Google Analytics integration.
  };
  theme?: { // Customization options for scene theme, including theme type (light, dark, forest, or custom), text color, selection color, and background color.
    themeType?: "light" | "dark" | "forest" | "custom"; // Specifies the overall theme type of the scene, which can be "light", "dark", "forest", or "custom".
    themeTextColor?: string; // Defines the text color used in the theme.
    themeSelectColor?: string; // Specifies the color used for selection in the theme.
    themeBackgroundColor?: string; // Defines the background color of the theme.
  };
};