MEMBERS

assetConfiguration :AssetConfiguration

IncisorAPI.js, line 3014

Object housing the details of the current asset configuration. Runtime changes to this value must be made in PreloadConfiguration code, which is located in the 'ProjectCode/PreloadConfiguration' local directory. When setting these values, ensure the chosen values exist within the 'assetConfigurationDefinitions' in the 'ProjectSettings.json' file, and the overall assetConfiguration must in the list of 'supportedAssetConfigurations' listed within the current configuration within the 'ProjectSettings.json' file.

canvasParent :object

IncisorAPI.js, line 2985

DOM object that the canvas will be made a child of. For many projects the best value for this item is the default. Changes to this value must be made in PreloadConfiguration code, which is located in the 'ProjectCode/PreloadConfiguration' local directory.

Default Value:

• document.body

canvasTransparency :boolean

IncisorAPI.js, line 2943

Boolean determining if any portion of the canvas will be transparent, enabling the html page to be partially viewed "through" the canvas.

Default Value:

• false

coreCanvasResolutionX :number

IncisorAPI.js, line 2928

The core canvas pixel width. This represents the pixel width of the canvas RenderTarget at it's native scale. Runtime changes to this value must be made in PreloadConfiguration code, which is located in the 'ProjectCode/PreloadConfiguration' local directory.

Default Value:

• 1920

coreCanvasResolutionY :number

IncisorAPI.js, line 2936

The core canvas pixel height. This represents the pixel height of the canvas RenderTarget at it's native scale. Runtime changes to this value must be made in PreloadConfiguration code, which is located in the 'ProjectCode/PreloadConfiguration' local directory.

Default Value:

• 1080

defaultGraphicAssetEffectNodes :Array.<string>

IncisorAPI.js, line 3005

List of Nodes added to the presets for all GraphicAssets. This item is determined by the associated field in the ProjectSettings.

fontDefinitions :FontDefinitions

IncisorAPI.js, line 3027

Object housing information about the fonts in this project.

readonly incisorVersion :string

IncisorAPI.js, line 2899

The specific 'version number' designation of the version of Incisor® that generated this project code.

readonly incisorVersionSet :string

IncisorAPI.js, line 2906

The 'version set' designation of the version of Incisor® that generated this project code.

readonly isProjectPublished :boolean

IncisorAPI.js, line 2992

Ready-only bool indicating if the project that is currently running is published.

loadingTierDefinitions :LoadingTierDefinitions

IncisorAPI.js, line 3021

Object housing information about the loading tiers in this project. Loading tiers are a means to organize AssetComponents into separately downloadable groups.

mainCameraType :string

IncisorAPI.js, line 2952

String value denoting the default camera type used for the 'mainCamera' in the 'mainScene'. Runtime changes to this value must be made in PreloadConfiguration code, which is located in the 'ProjectCode/PreloadConfiguration' local directory. Possible values for this property are 'orthographic' or 'perspective'.

Default Value:

• 'orthographic'

maskingMode :string

IncisorAPI.js, line 2963

String value denoting the masking mode for this project. The masking mode determines how different masks interact with eachother. Possible values for this property are 'overlapping' or 'disjoint'. When the maskingMode is 'overlapping', up to 8 masks can be defined and GraphicObjects can subscribe to any combination of those masks. When the maskingMode is 'disjoint', up to 255 masks can be defined, but GraphicObjects can only subscribe to one mask at a time.

Default Value:

• 'overlapping'

preserveDrawingBuffer :boolean

IncisorAPI.js, line 2976

Boolean value determining if the drawing buffer is preserved for reading. Preserving the drawing buffer enables several useful development features, but may cause performance issues in published software on some devices. It is therefore recommended that this flag be set to true for when the project is unpublished, and false for when the project is published. This can be done using a 'CODE.includeIf___published' within the 'preloadConfiguration' method in the PreloadConfiguration code.

Default Value:

• true

readonly projectName :string

IncisorAPI.js, line 2913

The name of the current Incisor® project as determined in the 'ProjectSettings'.

readonly publishTimestamp :string

IncisorAPI.js, line 2920

The date when the current project was published using the format "YYYY.MM.DD.hh.mm.ss". For unpublished projects, this value will be 'devMode'.

urlParams :object

IncisorAPI.js, line 2999

URL parameters. URL parameters included in the url used to access this project are automatically parsed and provided in this object.

METHODS

refreshWithUpdatedParams()

IncisorAPI.js, line 3038

Refreshes the project within the browser, applying current/updated values of 'ProjectConfiguration.urlParams'. For example, a project could have functionality to allow the end-user to change a custom configuration (e.i. themeColor) of the project from within the published project runtime, and this could be done by calling "nc.projectConfiguration.urlParams.themeColor = 'purple';", and then calling "nc.projectConfiguration.refreshWithUpdatedParams();". The browser would then refresh, the url would include the suffix "?themeColor=purple", and the nc.projectConfiguration.urlParams would be updated from the very beginning of the project runtime, allowing the configuration to inform the loading and setup process.