Optrix Documentation ardiscript

Activate

Tue, 24 Apr 2018 01:13:28 +0000

Activate Summary This function allows you to activate any deactivated asset in the scene. Note: Activating and deactivating assets also disables the ability for the targeted asset to receive property updates and process any attached functionality. Use with caution.

AddBeacon

Mon, 30 Apr 2018 01:11:17 +0000

AddBeacon Summary Adds a beacon to the 3D world attached to an asset, illuminating it with a ray of light and allowing the user to focus their attention towards the Target/ asset. Parameters Target Type: Path Default: None Specifies the name or ARDI ID of the asset you would like to have a beacon added to. If using an asset ID, begin the target with the '#' character.

AddImage

Wed, 20 Feb 2019 01:09:37 +0000

AddImage Summary This function allows you to add an Image to the user interface. By default, the image can be moved around by clicking and dragging on it or it can be removed by pressing on the cross at the top right of the image. Both of these features are optional and can be removed with the use of associated parameters.

AddLinkedPoints

Fri, 16 Nov 2018 04:28:22 +0000

AddLinkedPoints Summary This script will add several points to a scene and link them together with a line, allowing you to show a path. Parameters Points Type: XYZ Coordinates Default: None The world location of each point in the linked points line. Locations are given as global x,y,z co-ordinates separated by a comma for each axis and with a space for each individual co-ordinate.

AddMesh

Fri, 16 Nov 2018 04:19:22 +0000

AddMesh Summary The addmesh function is used to add a new asset to the 3D world by importing a 3D model object from a file. Parameters File Type: Path Default: None Specifies the path to the file which is to be imported. You may specify any 3D model file as long as it is one of the supported formats. The supported file formats are

AddMesh

Tue, 17 Sep 2019 23:20:26 +0000

AddParticle

Tue, 27 Nov 2018 00:57:48 +0000

AddParticle Summary This function allows you to create a particle effect asset in one of three types: liquid, solid or gas. The particle effect will show up in the ARDI Virtual Environment with appropriate graphical representation according to the particle type chosen.

AddQuestion

Mon, 29 Oct 2018 23:18:41 +0000

AddQuestion Summary This script allows you to add a question to the questionnaire which will have any amount of multiple answers and 1 correct answer. Parameters Question Type: Text Default: None The question to ask the user. Answers Type: Text Default: None

AddShape

Fri, 16 Nov 2018 04:19:34 +0000

AddShape Summary The AddShape function will allow you to create a predefined asset shape such as a Cube, Sphere, Capsule, Cylinder or Custom Polygon. Custom Polygon's can be defined as multiple XY Coordinates to create a flat shape using the points and then an

AddShape

Tue, 17 Sep 2019 23:20:57 +0000

AddShape Summary The AddShape function will allow you to create a predefined asset shape such as a Cube, Sphere, Capsule, Cylinder or Custom Polygon and attach it to a marker. Custom Polygon's can be defined as multiple XY Coordinates to create a flat shape using the points and then an

AddSubCamera

Fri, 27 Apr 2018 05:20:26 +0000

AddSubCamera Summary This function allows you to add a sub-camera to the scene. The sub camera can either be a World camera or Feed camera. World cameras produce footage from a virtual position within the scene, whereas Feed cameras obtain footage from a live streaming location such as the internet or local security camera.

Animate

Wed, 18 Sep 2019 00:10:19 +0000

Animate Summary This function will allow you to animate any 3D object added using the AddMesh function. Animations are created by specifying exact position, rotation and scale keyframes over time. Paramaters Target Type: Text Default: None Specifies the name of the object to be moved. This value is usually specified by the

AnimatePosition

Tue, 24 Apr 2018 02:16:37 +0000

AnimatePosition Summary This functions allows you to choose a Target asset in the 3D world and then have it move to another Position over time. You can specify either a single Position or multiple Positions. If multiple Positions are specified, the asset will smoothly transition through each specified position as waypoints.

AnimateProperty

Tue, 24 Apr 2018 02:15:14 +0000

AnimateProperty Summary This function will modify a property to change its value over a set amount of specified time. The value will begin at it's current value and gradually change until it reaches the value specified by the Value parameter. Parameters

Behaviour

Wed, 18 Apr 2018 00:52:45 +0000

Behaviour This is an internal ARDI function and should be used only when directed by Technical Support This function disables or enables internal asset behaviours and can be used to work around problems in 3D model implementation, or to temporarily remove unwanted effects.

Block

Tue, 17 Apr 2018 03:05:05 +0000

Block Summary This function pauses to allow all of the previous steps to complete before proceeding. Most useful in situations where you are unsure of the length of time the previous steps will take to complete, particularly when there are complex animations or voiceovers involved.

Boolean

Sun, 15 Apr 2018 22:36:04 +0000

Boolean Boolean properties have only two possible values - on or off. To specify one of these values, you can use any of the following... Off ValueOn Value01noyesfalsetrue

Box

Mon, 16 Sep 2019 23:50:48 +0000

Box A Box parameter allows you to specify a specific rectangle width and height automatically determined based on the opposing corner points of the rectangle. Co-ordinates are entered as UpperLeftX,UpperLeftY,BottomRightX,BottomRightY.

CameraLookAt

Fri, 27 Apr 2018 05:53:34 +0000

CameraLookAt Summary This function will cause the camera to face towards a specified asset. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you would like to have the camera face towards. If using an asset ID, begin the target with the '#' character.

Cleanup

Tue, 26 Feb 2019 23:21:21 +0000

Cleanup Summary This function erases any created geometry - including effects such as highlighting (Highlight, HighlightConnection) and the add functions (AddBeacon, AddMesh, AddShape etc.). Parameters This script action has no parameters. See Also AddMesh AddBeacon AddParticle AddLinkedPoints Remove DuplicateObject Highlight HighlightConnection Examples

Cleanup

Wed, 18 Sep 2019 03:21:15 +0000

Cleanup Summary This function erases any created objects or labels including effects such as AddMesh, AddShape and ImageLabel. Parameters This script action has no parameters. See Also AddMesh AddShape ImageLabel Remove Examples

ClearQuestions

Wed, 17 Oct 2018 04:43:12 +0000

ClearQuestions Summary This script will clear all questions from the questionnaire. Parameters None Examples " Simply running this line of code will clear the questionnaire of all questions." See Also AddQuestion StartQuestionnaire

Colour Arguments

Wed, 27 Feb 2019 00:06:53 +0000

Colour Arguments Colour arguments are made up of either three or four components - the red, green, blue and optionally transparency. Each is a number between 0 (none) and 1 (maximum). Each is separated from the other with a comma. For instance, black (which has

Culling Box

Thu, 15 Aug 2019 06:22:14 +0000

Culling Box Summary By default, each marker in ARDI-AR has an invisible plane which hides any attached models or images that would be positioned behind it. This is useful for any marker that is placed on a wall or a floor because it will simulate the flat area surrounding it that would obstruct anything behind it. However, when a marker is placed on a smaller object such as a box or piece of machinery, you can use this function to simulate the culling area of the box or machine in which the ma…

Deactivate

Tue, 24 Apr 2018 01:11:42 +0000

Deactivate Summary Deactivates an asset in the scene. A deactivated asset is hidden from view and can no longer perform actions or hold property values of any kind until it is re-activated again using the Activate function. A deactivated asset will remember its exact state upon deactivation and resume that exact state upon re-activation.

Deploying Scripts to your Server

Wed, 25 Jul 2018 22:48:14 +0000

Deploying Scripts to your Server If your script is looking good and you'd like to make it publically available, you can upload it to ARDI. If you haven't already tested it, we suggest first doing your development and testing locally - see Running And Debugging Scripts. This will make the script available in the

Disable Culling

Thu, 15 Aug 2019 05:55:06 +0000

Disable Culling Summary By default, each marker in ARDI-AR has an invisible plane which hides any attached models or images that would be positioned behind it. This is useful for any marker that is placed on a wall or a floor because it will simulate the flat area surrounding it that would obstruct anything behind it. However, when a marker is placed on a smaller or more complex object this may not be appropriate. You can use this function to disable automatic culling, allowing you to place a…

DisableVision

Thu, 26 Apr 2018 00:50:29 +0000

DisableVision Summary This function will make a property invisible so that it does not show up on in vision modes. Parameters Target Type: Text Default: everything Specifies the name or ARDI ID of the property you would like to make invisible. Make sure to include the respective asset path up to that asset that includes the property. If using an asset ID, begin the target with the '#' character.

DuplicateObject

Fri, 27 Apr 2018 05:57:17 +0000

DuplicateObject Summary This function allows you to create a duplicate of an already existing asset. You may also rename the new duplicate, change its position or parent it to another asset. Parameters Target Type: Text Default: None Specifies the

Enable Culling

Thu, 15 Aug 2019 05:58:23 +0000

Enable Culling Summary By default, each marker in ARDI-AR has an invisible plane which hides any attached models or images that would be positioned behind it. This is useful for any marker that is placed on a wall or a floor because it will simulate the flat area surrounding it that would obstruct anything behind it. It is possible to use

EnableVision

Thu, 26 Apr 2018 02:59:16 +0000

EnableVision Summary This function will allow you to make a specified property visible in vision modes. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the property you would like to make visible. Make sure to include the respective asset path up to that asset that includes the property. If using an asset ID, begin the target with the '#' character.

Fade

Fri, 20 Apr 2018 05:45:22 +0000

Fade Summary This function allows you to choose an asset in the virtual environment and have it fade out. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you would like to fade. If using an asset ID, begin the target with the '#' character.

FadeEverythingBut

Mon, 23 Apr 2018 22:29:38 +0000

FadeEverythingBut Summary This function allows you to specify a single asset and fade every other asset in the scene. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you would like to have remain unfaded, every other asset will fade out. If using an asset ID, begin the target with the '#' character.

FadeFrom

Mon, 23 Apr 2018 23:22:39 +0000

FadeFrom Summary This function will fade the entire screen from a colour back to its original state. Parameters Colour Type: Text Default: black The name of the type of colour you wish to fade from. See Also FadeTo Fade FadeEverythingBut FadeUntagged FadeTag Examples

FadeTag

Tue, 11 Dec 2018 02:02:02 +0000

FadeTag Summary This function will fade all assets with the specified type. Parameters Tag Type: Text Default: None The name of the type to be checked. If an asset contains this type, it will be faded out. Amount Type: Float Default: 0.05 The amount of transparency to apply all of the faded assets. A value of 1.0 is completely opaque, a value of 0.0 is completely invisible. Any value in between 0.0 and 1.0 denotes how visible the asset will be.

FadeTo

Mon, 23 Apr 2018 22:37:07 +0000

FadeTo Summary This function will fade the entire screen to a colour of your choosing. Parameters Colour Type: Text Default: black The name of the type of colour you wish to fade to. See Also Fade FadeFrom FadeEverythingBut FadeTag Examples " This function call will fade the screen to white.

FadeUntagged

Mon, 23 Apr 2018 23:05:51 +0000

FadeUntagged Summary This function will fade all assets without the specified tag. Parameters Tag Type: Text Default: None The name of the tag to be checked. If an asset does not contain this tag, it will be faded out. Amount Type: Float Default:

Float

Fri, 20 Apr 2018 06:02:24 +0000

Float A Floats is a numbered datatype that allows for both whole numbers and fractional numbers represented with a decimal point. Examples of valid Float values are: 1, 0, 0.5, 3.5, 32.635, 7889.1

HideObject

Fri, 16 Nov 2018 04:16:36 +0000

HideObject Summary This function will hide an asset from view. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you wish to hide. If using an asset ID, begin the target with the '#' character. AndChildren

HideRelationships

Tue, 24 Apr 2018 01:45:34 +0000

HideRelationships Summary This function will hide all asset relationships. Parameters There are no parameters. See Also ShowRelationship ShowOnlyRelated TourRelationship ShowObject HideObject Examples " Hides all asset relationships."

HighlightConnection

Tue, 26 Feb 2019 23:16:19 +0000

HighlightConnection Summary This function draws bright lines inside existing connections to help highlight flow routes. These will remain in the scene until Cleanup is called, or they are destroyed by name with Remove. Parameters From Type: Asset Default: None

Highlight

Wed, 27 Feb 2019 00:07:15 +0000

Highlight Summary This function will highlight an asset within the Virtual Environment. Child assets will also be highlighted by default, however this feature is optional (see Children). Assets will remain highlighted until an UnHighlight function call is made to the highlighted asset, or

ImageLabel

Wed, 18 Sep 2019 01:28:48 +0000

ImageLabel Summary This function allows you to attach an image to the marker. Parameters Image Type: Text Default: None This is the name of the image file to be attached to the marker. The image must be placed in the proper folder location as defined by the ARDI AR Script System.

ARDI Scripting Documentation Index

Wed, 14 Aug 2019 00:33:45 +0000

ARDI Scripting Documentation Index What Is Scripting Scripts allow you to control your ARDI experience using a pre-made XML script. You can control the camera, toggle view options, inject data into assets, filter assets - in fact, there is an ever-growing list of what you can do using the system.

Script Function Index - By Category

Tue, 26 Feb 2019 23:24:26 +0000

Script Function Index - By Category Audio VoiceOver - Play a voiceover or other audio file. Control Block - Wait until previous steps have completed. Pause - Wait a set amount of time WaitForClick - Wait until the user clicks 'next' Behaviour - Enable or disable a behaviour. Internal use only

Script Function Index - By Category

Wed, 18 Sep 2019 03:19:09 +0000

Script Function Index - By Category Audio VoiceOver - Play a voiceover or other audio file. Control WaitForClick - Wait until the user clicks 'next' Creation and Destruction AddMesh - Add a 3D mesh attached to a marker AddShape - Add a simple 3D shape attached to a marker CleanUp - Delete all created objects and applied effects

Script Function Index - By Name

Tue, 26 Feb 2019 23:22:29 +0000

Script Function Index - By Name A Activate - Activate an asset in the scene. AddBeacon - Add a shaft of light to indicate an asset location. AddImage - Add an image to the UI AddLinkedPoints - Add a set of linked points forming a line. AddMesh - Add a 3D model to the scene AddParticle - Add a source of particles (liquid/gas/rock etc.) to the scene.

Script Function Index - By Name

Wed, 18 Sep 2019 03:02:18 +0000

Script Function Index - By Name A AddMesh - Add a 3D mesh attached to a marker AddShape - Add a simple 3D shape attached to a marker Animate - Move an object to a new position C Cleanup - Delete all created objects and applied effects Culling Box - Specify a manual 3D box area of culling around the marker.

Indicator

Wed, 18 Sep 2019 02:32:37 +0000

Indicator Summary This function creates an indicator asset and places it in the virtual environment at a specified position. This is useful for adding markers or notes to guide users towards specific areas or assets. Parameters Target Type: Text Default: None

Indicator

Wed, 18 Sep 2019 02:42:14 +0000

Indicators

Fri, 20 Apr 2018 04:39:36 +0000

Indicators Summary This function toggles whether or not Indicators are enabled. Parameters On Type: Boolean Default: True This parameter specifies whether or not indicators are visible. If true, indicators will be shown, otherwise indicators will be hidden.

KeyFrame

Tue, 17 Sep 2019 22:14:09 +0000

KeyFrame KeyFrames are values used to create an animation in which each point is met over a certain amount of time. KeyFrames are entered as time,x,y,z and each KeyFrame value is space delimited. For example, with a set of KeyFrames “0,0,5,0 2,10,10,20 4,20,20,20

LockCurrentRange

Tue, 24 Apr 2018 01:40:32 +0000

LockCurrentRange Summary This function will lock the current visual range. Parameters There are no parameters. See Also LockRange UnlockRange Examples " This code will lock the range of the camera and prompt the user with a message. Once they click next, the range will be unlocked as normal.

LockRange

Tue, 24 Apr 2018 02:05:39 +0000

LockRange Summary This function will lock the visual range between specified minimum and maximum values. Parameters Minimum Type: Float Default: 0 The minimum distance for visual range to be locked to. The camera can be no closer than this amount to the viewed asset.

Magnify

Mon, 26 Nov 2018 03:08:14 +0000

Magnify Summary Parameters See Also Examples

MoveCamera

Fri, 27 Apr 2018 05:55:06 +0000

MoveCamera Summary This function allows you to move the camera to another object and offset the position by a certain amount defined by XYZ Coordinates values. The camera will smoothly transition from its current location to the specified object and offset position.

Path

Mon, 16 Apr 2018 02:05:12 +0000

Path A path links to a specific file that you would like to reference from your script. When running a local file, the file is expected to be located under your %USERDIR%\Documents\ARDI\\Scripts folder.

Pause

Mon, 16 Apr 2018 05:36:54 +0000

Pause Summary This function will cause the the script to wait a specified amount of time before executing the next function in the script. This can be useful to let certain properties or assets to play out their animations before proceeding with any further modifications.

PauseLiveData

Thu, 19 Apr 2018 06:35:14 +0000

PauseLiveData Summary This function will allow you to pause the feed of live data into the virtual environment. All properties will be unable to receive any modifications from external sources until a ResumeLiveData function call is made. Examples

Perspective

Sun, 22 Jul 2018 23:48:56 +0000

Perspective Summary The perspective function is used to move the camera so it looks at one or more assets. You can nominate the name (or ARDI asset ID) of the asset, or one or more special names that allow you to look at multiple assets simultaniously.

PinClear

Tue, 24 Apr 2018 05:44:22 +0000

PinClear Summary This function allows you to clear all pinned properties from view. Properties can be pinned using the PinProperty function or unpinned individually using the UnPinProperty function. Parameters There are no parameters for this function. See Also PinProperty UnPinProperty Examples

PinProperty

Tue, 24 Apr 2018 05:28:22 +0000

PinProperty Summary This function allows you to pin a property to make it more easily visible and accessible when there are a large amount of properties to keep track of. This lets you bring focus to the properties that are important for the users purpose.

PointAt

Tue, 24 Apr 2018 03:29:05 +0000

PointAt Summary This function causes a specified asset to rotate so that its front side is facing towards another asset in the scene. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you want to rotate. If using an asset ID, begin the target with the '#' character.

Primitive

Fri, 20 Apr 2018 04:18:28 +0000

Primitive A primitive shape type, used to define a type of simple 3D asset within the virtual environment. The type of allowable primitaves are: 3D ShapeDescriptioncubeCreates an asset with a Cube shaped mesh.cylinderCreates an asset with a Cylinder shaped mesh.

RefreshVision

Thu, 26 Apr 2018 02:58:45 +0000

RefreshVision Summary This function allows you to refresh the current visionmode. Refreshing the visionmode may be necessary if specific properties that are viewed by the current visionmode have been modified. If modifications to property values are not reflected by the current visionmode, calling the

Remove

Tue, 24 Apr 2018 02:11:39 +0000

Remove Summary This function removes a Target asset from the 3D World. Parameters Target Type: Path Default: None Specifies the name or ARDI ID of the asset you would like to remove. If using an asset ID, begin the target with the '#' character. See Also

Remove

Wed, 18 Sep 2019 03:21:56 +0000

Remove Summary This function removes a Target asset from the 3D World. Parameters Target Type: Path Default: None Specifies the name of the attached object you wish to remove. This value must be set by the Name parameter on certain objects such as

RemoveBeacon

Mon, 30 Apr 2018 01:14:19 +0000

RemoveBeacon Summary Remove a beacon that was added to the scene from the AddBeacon function. Parameters Target Type: Path Default: None Specifies the name or ARDI ID of the asset you would like to remove a beacon from. If using an asset ID, begin the target with the '#' character.

RemoveImage

Wed, 20 Feb 2019 01:11:06 +0000

RemoveImage Summary This function allows you to remove and image from the user interface using the name specified by a parameter from the AddImage function. Parameters Name Type: Text Default: None The name of the image you wish to remove. This should be the same name that was specified by the

RemoveLastSubCamera

Fri, 27 Apr 2018 05:23:27 +0000

RemoveLastSubCamera Summary This function removes the last sub-camera added, regardless of whether it is a Feed camera or a World camera. Parameters There are no parameters for this function. See Also AddSubCamera RemoveSubCamera Examples

RemoveSubCamera

Fri, 27 Apr 2018 05:28:16 +0000

RemoveSubCamera Summary This function allows you to specify the name of a sub-camera to be removed from the scene. The name of the sub-camera must be exactly as defined by the AddSubCamera function. Parameters Name Type: Text Default: None The name of the sub-camera to be removed. Must be exactly as defined by the

ResumeLiveData

Thu, 19 Apr 2018 06:35:03 +0000

ResumeLiveData Summary This function will resume receiving live data from external sources in the event that receiving live data has been paused by PauseLiveData function call. Examples " This function will resume receiving live data from external sources. Useful if live data has been stopped from a call to

RGB

Fri, 20 Apr 2018 05:18:12 +0000

RGB RGB or (Red, Green, Blue) Values are a set of 3 numbers that indicate an amount of Red, Green or Blue colors to be mixed together to form an overall color. In ARDI VE, RGB colors are specified using normalized values (values from 0.0 to 1.0) including any fractional values in between.

RGBA

Fri, 20 Apr 2018 05:21:07 +0000

RGBA RGBA or (Red, Green, Blue, Alpha) Values are a set of 4 numbers that indicate an amount of Red, Green or Blue colors to be mixed together to form an overall color along with a fourth value Alpha. The Alpha value indicates the amount of transparency to be applied to the color, 1.0 indicates 100% visibility and is completely opaque whereas a value of 0.0 indicates 0% visibility and is completely invisible.

Running And Debugging Scripts

Wed, 25 Jul 2018 22:46:16 +0000

Running And Debugging Scripts Script Location When you start working on your script, you want to keep it on your own computer(s), rather than publish it for all ARDI users to see. ARDI provides a directory to keep all of your scripts (and any associated media files, such as voiceovers, images and videos).

RunScript

Wed, 17 Oct 2018 05:05:37 +0000

RunScript Summary This script allows you to a run another script from within this script. Parameters ScriptFile Type: Path Default: None The file name of the script to be run. Script files should be located in the \Scripts folder of our ARDI installation.

SetPosition

Mon, 24 Sep 2018 01:54:37 +0000

SetPosition Summary This function allows you to immediately set the position of any given asset to a fixed position based on XYZ Coordinates Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you wish to set the position for. If using an asset ID, begin the target with the '#' character.

SetProperty

Tue, 24 Apr 2018 05:17:07 +0000

SetProperty Summary Set a property to a specific value. The specified property can be any property on an asset in the 3D world. Parameters Target Type: Path Default: None Specifies the name or ARDI ID of the property you would like to modify. If using an asset ID, begin the target with the '#' character.

SetValue

Wed, 18 Apr 2018 00:53:47 +0000

SetValue This is an internal ARDI function and should be used only when directed by Technical Support This allows internal variables on existing assets to be modified. It is used to correct errors in assets and Unity-based models.

SetWorldScale

Wed, 18 Sep 2019 03:17:27 +0000

SetWorldScale Summary This function allows you to specify a value in which to convert real-world measurements into ARDI-AR world measurements. Parameters Scale Type: Float Default: 34 The scale in which to convert from entered units to in-world units. With a scale of 25, 1 unit will be equivalent to 1 millimeter.

ShowObject

Fri, 16 Nov 2018 04:16:23 +0000

ShowObject Summary This function will reveal an asset that has been hidden by HideObject. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you wish to hide. If using an asset ID, begin the target with the '#' character.

ShowLevel

Fri, 16 Nov 2018 04:16:55 +0000

ShowLevel Summary This script will show or hide a level in the Virtual Environment. Parameters Target Type: Text Default: None The name of the level you wish to show or hide. SelectAs Type: Text Default: Solo This parameter specifies the way in which the target level will be shown.

ShowOnlyRelated

Tue, 24 Apr 2018 01:45:09 +0000

ShowOnlyRelated Summary This function will show only assets in the scene that contain relationships with a specified asset. Parameters Asset Type: Text Default: None The name of the asset that you wish to show assets that are related to. Dir

ShowRelationship

Tue, 24 Apr 2018 01:45:21 +0000

ShowRelationship Summary This function will show a single relationship of a single asset in the scene. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you want to show the relationship for. If using an asset ID, begin the target with the '#' character.

StartQuestionnaire

Wed, 12 Dec 2018 22:49:10 +0000

StartQuestionnaire Summary This script will begin the questionnaire. Any questions loaded with AddQuestion will be sorted and presented to the user with multiple choice answers as clickable buttons. The questionnaire can be sorted in order or with the questions and/or answers shuffled randomly.

Supported Script Media Formats

Wed, 25 Jul 2018 22:45:04 +0000

Supported Script Media Formats The ARDI-VE scripting system allows you to play back a few different types of media, including sound files, videos and images. It's important to know which file-formats to use. FunctionFormatExtensionSuggested Appvoiceover

TextureMove

Thu, 19 Apr 2018 06:16:19 +0000

TextureMove Summary This function will allow you to control the texture on a given asset and cause it to shift or move in a certain way to simulate a rolling surface effect. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset containing the texture you wish to move. Make sure to include the respective asset path up to that asset that includes the texture. If using an asset ID, begin the target with the '#' character.

TourRelationship

Tue, 24 Apr 2018 01:56:26 +0000

TourRelationship Summary This function allows you to follow a relationship and observe each of its relative assets in sequence. Parameters Target Type: Text Default: None Specifies the name or ARDI ID of the asset you want to show the relationship for. If using an asset ID, begin the target with the '#' character.

UnFade

Tue, 24 Apr 2018 03:48:20 +0000

UnFade Summary This function will find a specified faded asset and unfade it. Target Type: Text Default: None Specifies the name or ARDI ID of the asset you would like to unfade. If using an asset ID, begin the target with the '#' character. AndChildren

UnFadeEverything

Tue, 24 Apr 2018 03:08:52 +0000

UnFadeEverything Summary This function will un-fade all assets that are currently faded, making them completely visible and opaque. Parameters There are no parameters. See Also Fade FadeEverythingBut FadeTag FadeUntagged FadeTo FadeFrom UnFade UnFadeTag Examples

UnFadeTag

Tue, 24 Apr 2018 04:22:21 +0000

UnFadeTag Summary This function will unfade all assets with the specified tag making them completely opaque and visible. Paramaters Tag Type: Text Default: None The name of the tag to be checked. If an asset contains this tag, it will be unfaded and become completely visible.

UnHighlight

Fri, 20 Apr 2018 00:39:38 +0000

UnHighlight Summary Use this function to remove a highlighted asset if a Highlight call was made to it earlier. Child assets will also be unhighlighted by default, however this feature is optional (see AndChildren). Parameters Target Type: Text Default: None

UnlockRange

Tue, 24 Apr 2018 02:03:46 +0000

UnlockRange Summary This function will unlock the visual range of the camera allowing the user to freely navigate the scene without restriction. Parameters There are no parameters. See Also LockRange LockCurrentRange Examples

UnPinProperty

Tue, 24 Apr 2018 05:30:41 +0000

UnPinProperty Summary This function allows you to remove a property that was pinned using the PinProperty function. Parameters Target Type: Path Default: None Specifies the name or ARDI ID of the property you would like to unpin. If using an asset ID, begin the target with the '#' character.

ViewMedia

Wed, 20 Feb 2019 01:10:42 +0000

ViewMedia Summary This script command allows you to display an image or playback a movie using the ARDI Interface. Parameters Media Type: Path Default: None This is the name of the image or movie file to be viewed. The media file must be placed in the proper folder location as defined by the ARDI VE System.

VisionMode

Sun, 29 Apr 2018 23:48:16 +0000

VisionMode Summary This function allows you to change the vision mode to any legal vision mode in the current scene. Parameters Name Type: Text Default: None This parameter specifies the name of the vision mode you wish to change to. The vision mode must be a legal vision mode in the current scene.

VisionOption

Sun, 22 Jul 2018 23:13:51 +0000

VisionOption Summary Toggle visual options (such as alert indicators or voxelisation). Parameters Name Type: Text Default: alerts The name of the visual option you would like to alter. It must be one of the values in the following list... Name

VoiceOver

Tue, 19 Feb 2019 22:18:51 +0000

VoiceOver Summary This function will let you specify an audio file containing voice over to be played. Parameters Name Type: Text Default: None The name of the audio resource file containing the voice over. The audio file must be a file format of

WaitForClick

Wed, 18 Apr 2018 00:26:45 +0000

WaitForClick Summary This function opens a simple user interface to allow the user to click 'next' to proceed. All of the previously started script functions will continue and complete in the background, but no new script functions will run until the user clicks on the button.

XY Coordinates

Fri, 20 Apr 2018 04:22:16 +0000

XY Coordinates XY coordinates are 2 sets of values to denote a position on a 2D plane. XY coordinates are denoted using a space. For example: “10 25” will determine a point 10 units along the X plane and 25 units along the Y plane. See Also XYZ Coordinates

XYZ Coordinates

Fri, 20 Apr 2018 04:22:44 +0000

XYZ Coordinates The 3D co-ordinates which specify a point in 3D space. 3D coordinates are specified using values x,y,z with a ',' to separate them. e.g. a value of “3,6,2” specifies a point in 3D space 3 units along the X plane, 6 units along the Y plane and 2 units along the Z plane.