Global

Members

AxParameterType

Represents a type of a axis' parameter
Source:

AxRenderState

Represents a render state setting used for the graphics device
Source:

AxResourceType :Object

Represents a resource type for an AxResource object
Type:
  • Object
Source:

AxTransformOperation

Represents a trasform operation Transform operations are used by transform layers, which in turn are used in transforms to define a transforming operation
Source:

StreamSeekMode

Defines a mode for seeking through a stream
Source:

StreamWriteMode :Object

Denotes the writing mode for a stream
Type:
  • Object
Source:

Methods

AxisInitialize(onLoadednon-null, onProgressnon-null) → {undefined}

Initializes Axis web engine by loading all necessary files of the library
Parameters:
Name Type Description
onLoaded ScriptFilesLoadedCallback Callback which gets fired once all libraries have been loaded and axis is ready to go
onProgress ScriptFilesLoadProgressCallback Callback which gets fired each time the intialization has progressed. A Number parameter gives the progression percentage
Source:
Returns:
Type
undefined

AxisInitialize(onLoadednon-null, onProgressnon-null) → {undefined}

This function is provided only for consistency with Axis production project. Originally, in the Axis production project, this function initializes Axis web engine by loading all necessary files of the library When loading Axis from a single .js file, it is unnecessary and is provided only to be available, so switching between the prodution project and the single compiled file would be seemless.
Parameters:
Name Type Description
onLoaded ScriptFilesLoadedCallback Callback which gets fired once all libraries have been loaded and axis is ready to go
onProgress ScriptFilesLoadProgressCallback Callback which gets fired each time the intialization has progressed. A Number parameter gives the progression percentage
Source:
Returns:
Type
undefined

getHeartModel() → {AxStream}

Generated by the Axis 3D engine http://palitri.com/axis/
Source:
Returns:
Returns a stream containing an Axis scene. The stream can be used as an input to the Axis.ImportScene() method
Type
AxStream

LoadScriptFile(scriptFileUrl, onLoaded)

Loads a javascript file
Parameters:
Name Type Description
scriptFileUrl string Url of a script file to be loaded. The url can be of a local or http file
onLoaded ScriptFileLoadedCallback Callback which gets fired after the script file has been loaded
Source:

LoadScriptFilesSequential(fileIndex, onLoadednon-null, onProgressnon-null)

Loads Axis' script files sequentially, starting from the given index For internal use
Parameters:
Name Type Description
fileIndex type The index of the script file to start loading from
onLoaded ScriptFilesLoadedCallback Callback, which gets called when the final file has been loaded
onProgress ScriptFilesLoadProgressCallback Callback which gets called when a file has been loaded
Source:

LoadSourceFile(sourceFileUrl, onLoaded)

Loads a javascript file
Parameters:
Name Type Description
sourceFileUrl string Url of a script file to be loaded. The url can be of a local or http file
onLoaded ScriptFileLoadedCallback Callback which gets fired after the script file has been loaded
Source:

LoadSourceFile(sourceFileUrl, onLoaded)

Loads a javascript file
Parameters:
Name Type Description
sourceFileUrl string Url of a script file to be loaded. The url can be of a local or http file
onLoaded ScriptFileLoadedCallback Callback which gets fired after the script file has been loaded
Source:

LoadSourceFilesSequential(fileIndex, onLoadednon-null, onProgressnon-null)

Loads source files sequentially, starting from the given index
Parameters:
Name Type Description
fileIndex type The index of the script file to start loading from
onLoaded ScriptFilesLoadedCallback Callback, which gets called when the final file has been loaded
onProgress ScriptFilesLoadProgressCallback Callback which gets called when a file has been loaded
Source:

LoadSourceFilesSequential(fileIndex, onLoadednon-null, onProgressnon-null)

Loads source files sequentially, starting from the given index
Parameters:
Name Type Description
fileIndex type The index of the script file to start loading from
onLoaded ScriptFilesLoadedCallback Callback, which gets called when the final file has been loaded
onProgress ScriptFilesLoadProgressCallback Callback which gets called when a file has been loaded
Source:

SourceInitialize(onLoadednon-null, onProgressnon-null) → {undefined}

Loads source files. This method of dynamic loading allows for the page to be displayed before the source files are actually loaded, giving the ability to display an image while loading
Parameters:
Name Type Description
onLoaded SourceFilesLoadedCallback Callback which gets fired once all libraries have been loaded and axis is ready to go
onProgress SourceFilesLoadProgressCallback Callback which gets fired each time the intialization has progressed. A Number parameter gives the progression percentage
Source:
Returns:
Type
undefined

SourceInitialize(onLoadednon-null, onProgressnon-null) → {undefined}

Loads source files. This method of dynamic loading allows for the page to be displayed before the source files are actually loaded, giving the ability to display an image while loading
Parameters:
Name Type Description
onLoaded SourceFilesLoadedCallback Callback which gets fired once all libraries have been loaded and axis is ready to go
onProgress SourceFilesLoadProgressCallback Callback which gets fired each time the intialization has progressed. A Number parameter gives the progression percentage
Source:
Returns:
Type
undefined

Type Definitions

AxAnimationElementRender()

Gets fired when an AxAnimationElement is ready to render a frame
Source:

AxFileSystemFileOpened(context, stream, path, fileSystem)

Gets fired when a file system has openened a file asynchronously and the file stream is ready
Parameters:
Name Type Description
context * The opened file's stream
stream AxStream The opened file's stream
path AxString The path of the opened file
fileSystem AxFileSystem A reference to the file system
Source:

AxImageLoadedCallback(caller, context, succeeded)

Gets fired when an image gets loaded
Parameters:
Name Type Description
caller * The image object, which was loaded
context * An object holding the context for the callback. It is the object passed to the Load method
succeeded Boolean True if the loading was successful, false otherwise
Source:

AxisObjectLoadedCallback(caller, context, object)

Gets fired when an object has been loaded Used for callback functions, where an object has to be loaded and returned when loading has finished Generally, a caller initiates the loading, by calling its loading method. The loading method accepts the required parameters, along with the callback function itself and a context object, which will be passed to the callback function. The context is provided for convenience and can hold any value, but usually it is the object from whithin which the caller's loading method was invoked Useful for example, when loading textures, images and etc.
Parameters:
Name Type Description
caller * The instance of Axis, which did the loading and caused the callback
context * An object holding the context for the callback. It is the object passed to the Loading method
object * If loading was successful, holds the loaded object. Otherwise has a value of null.
Source:

AxTexture2DLoadedCallback(caller, context, succeeded)

Gets fired when a texture gets loaded
Parameters:
Name Type Description
caller * The texutre object, which was loaded
context * An object holding the context for the callback. It is the object passed to the Loading method
succeeded Boolean True if the loading was successful, false otherwise
Source:

ScriptFileLoadedCallback(The)

Gets fired when LoadScriptFile finishes loading a script file
Parameters:
Name Type Description
The string url of the loaded file
Source:

ScriptFilesLoadedCallback()

Gets fired when Axis is fully loaded by the AxisInitialize method
Source:

ScriptFilesLoadedCallback()

Gets fired when Axis is fully loaded by the AxisInitialize method
Source:

ScriptFilesLoadProgressCallback(Percentage, Url)

Gets fired when a script file Axis web library progresses on loading
Parameters:
Name Type Description
Percentage Number of loading progress
Url string of the file just loaded
Source:

ScriptFilesLoadProgressCallback(Percentage, Url)

Gets fired when the Axis web library progresses on loading a script file
Parameters:
Name Type Description
Percentage Number of loading progress
Url string of the file just loaded
Source:

SourceFilesLoadedCallback()

Gets fired when Axis is fully loaded by the AxisInitialize method
Source:

SourceFilesLoadedCallback()

Gets fired when Axis is fully loaded by the AxisInitialize method
Source:

SourceFilesLoadProgressCallback(Percentage, Url)

Gets fired when a script file Axis web library progresses on loading
Parameters:
Name Type Description
Percentage Number of loading progress
Url string of the file just loaded
Source:

SourceFilesLoadProgressCallback(Percentage, Url)

Gets fired when a script file Axis web library progresses on loading
Parameters:
Name Type Description
Percentage Number of loading progress
Url string of the file just loaded
Source:

Documentation generated by JSDoc 3.5.3 on Wed Jan 17 2018 17:06:56 GMT+0200 (FLE Standard Time)