Constructor

• geometry

  The geometry is the structure or the shape of a hologram.

• material

  A material defines how the appearance of a geometry.

• {PARAMETERS}

  A set of parameters containing two values:
  propagate: boolean. Specify whether actions, such as onTap, should propagate to the parent or not. Default is true
  isHotspot: boolean. Specify whether the mesh is interactable or not. Default is false.
  isCollab: boolean. Specify whether the mesh interactability is propagated through the HoloCollab component or not. Default is false.

Properties

• children

  Returns an array of the HoloMesh's children.

• id

  A unique HoloMesh numeric identifier (readonly).

• name

  Represent the HoloMesh's name.

• parent

  Represent the HoloMesh's parent.

• position

  Represent the HoloMesh's local position.

• rotation

  Represent the HoloMesh's local rotation (in radians).

• scale

  Represent the HoloMesh's local scale.

• holoType

  Returns the type of this object. Example: HoloMesh.

• userData

  An object that could be used by developers to store their own custom data about the HoloMesh.
  Note:It should not hold references to functions.
  Example: HoloMesh.userData = { propertyname: “property value” };
  And to use the property: HoloMesh.userData.propertyname;

• visible

  if set to false the HoloMesh would not get rendered.

Methods

• onGaze
  = callbackfunction

  The callbackfunction that is called when a user gazes on a mesh. Note: This function depends on two other properties.onGaze.repeat: boolean that specifies if the callback function will repeat if the user is still gazing on the mesh. Default is false. onGaze.timer: float that represents the time to fire the callback after the user gazes on the mesh. And in the case that repeat is true, it acts as an interval between every callback.

• onGazeEnter
  = callBackFunction

  The callBackFunction that is called onGazeEnter event: when the user gazes on the HoloMesh.

• onGazeExit
  = callBackFunction

  The callBackFunction that is called onGazeExit event: when the user gazes does not intersect with the HoloMesh anymore.

• onTap
  = callBackFunction
  (Cursors)

  The callBackFunction that is called on a tap event. A tap event could happend in several ways: a combination of user hand gazing, eye gazing, or head gazing on the HoloMesh from far away and hand presses and releases gesture (far mode). Or a user hand index finger pressing on the HoloMesh (near mode)
  The callBackFunction can optionally return onlt the cursor objects which interacted with the HoloMesh. These objects are accessible via their HoloBuild.CursorType (example Cursors.cursor[HoloBuild.CursorTypeHandRight]).
  Note: for the onTap event to work, the object isHotspot parameter must be set to true.

• onHold
  = callBackFunction
  (previousPos,
  currentPos)

  The callBackFunction that is called on a hold event: a combination of user gaze on the HoloMesh and the user hand press and moving gesture. The callbackfunction will be called with a data parameter. The data parameter includes, the curosr information and 2 positions vectors, the previous position and the current one.

• onRelease
  = callBackFunction

  The callbackfunction that is called on a release event: a combination of user gaze on the HoloMesh and hand releases gesture. Other ways for the onRelease function to be called is if the user gestures get lost from the frame of view.

• setAnimImage(image, {PARAMETERS})

  The setAnimImage sets an animated image on the HoloMesh, it takes as input an image file name. The image's file contains a set of images (or frames) concatenated next to each, which will be played in a loop (similar to an animated gif). An example animated gif: animated-block.gif Optionally the set image can take other parameters as an object that can contain the following:
  width — Float. The frame width, by default the frame width is considered equal to the image's height.
  

• setImage(image,
  {PARAMETERS},
  callback)

  The setImage sets an image on the HoloMesh, it takes as input an image file name. Optionally the set image can take other parameters as an object that can contain the following:
  repeat — Boolean. If true the image will be repeated across the HoloMesh. Default is false.
  stretch — Boolean. If true the image will be stretched across the HoloMesh. Default is true.
  textureRepeatX — Number. How many times the texture is repeated across the X axis. Default is 1.
  textureRepeatY — Number. How many times the texture is repeated across the Y axis. Default is 1.
  Note: the image should be sized to a power of 2 (ie 256, 512, 1024).

• setTagAlong(boolean,{PARAMETERS})

  if set to true, the HoloMesh will never fully leaves the user's view. it will act as if it is attached to the user's head by rubber bands: When the user moves, the content will stay in his view. {PARAMETERS}:
  position: HoloVector3. Specifies how far the HoloMesh would be from the user: var tagAlongDistance = new HoloBuild.HoloVector3(0,0,0.5);
  radius: - float. Specifies how far should the cursor be from the holoMesh before it adjusts and return to the field of view. Default is the radius of the bounding sphere of the HoloMesh.

• setTooltip(value,
  {PARAMETERS})

  The setTooltip shows a text on top of the HoloMesh that will be shown if the user hover at the HoloMesh for over a 1 second, it takes as input a text value. Optionally the setTooltip can take other parameters as an object that can contain the following:
  fontSize — number. The tooltip size. Default is 0.021 meters.
  color — color. The tooltip text color. Default is 0xFFFFFF.
  bgColor — color. The tooltip background color. Default is 0x048ad7.
  showLine — Boolean. If set to true the tooltip will have a dotted line drawn from the ToolTip down to the HoloMesh. Default is false.
  rounded — Boolean. If true, the tooltip will be rounded. Default is set to true.
  borderColor- color. The tooltip border color. Default is null.
  hoverTime- float. Time to show the tooltip. Default 0.7 seconds
  position- stirng. Specify whether the toolTip should appear from above or below the mesh. Options are "top" and "bottom". Default is "top"
  gap — number. The gap in meters between the HoloMesh and the tooltip. Default is 0.035.
  yPos — number. The tooltip size. Default is 0.
  faceCamera — Boolean. If the tooltip will always face the user or not. Default is true.
  

• unsetTooltip()

  Removes any attached tooltip from the mesh. This does not hide the tooltip, so once you unset it you must set it again using the setTooltip method above.

• animateMove
  (loc, duration, pause,
  callback,
  {parameters})

  animateMove method provides an animated move that interpolate between the current position and the new location. Location is a 3D vertix. It also takes as input an animation duration, an animation pauses before start, and a callback function when the animation is done.
  Optional parameters include:
  incrementX, incrementY, and incrementZ a boolean parameter for each axis, if set to false it will move the mesh to the new pos, if set to true it will increment the mesh current position with the old position based on that axis. Default is true
  Example 1:
  holomesh.position.set(0, 0, 0.5);
  holomesh.animateMove({ x: 0, y: 0, z: 0.1 }, 750, 250);
  
  In This example the holomesh will move to Z 0.6 (an increment on its current position), the animation will then pause for 250 milliseconds, and will last for 750 milliseconds.
  
  Example 2:
  holomesh.animateMove( { x: 0, y: 0, z: 0.1 }, 750, 250, '', {incrementZ:false} );
  
  In This example the holomesh will move to Z 0.1, the animation will then pause for 250 milliseconds, and will last for 750 milliseconds.

• animateScale
  (scale, duration,
  pause, callback,
  {parameters})

  animateScale is similar to animateMove but for scaling. This method provides an animated scale that interpolate between the current scale and the new scale. Scale is a 3D vertix. It also takes as input an animation duration, an animation pause before start, and a callback function when the animation is done.
  Optional parameters include: incrementX, incrementY, and incrementZ a boolean parameter for each axis, if set to false it will scale the mesh to the new scale, if set to true it will increment the mesh current scale with the old scale based on that axis. Default is true
  Ex: holomesh.animateScale({ x: 1.25, y: 1.25 }, 250, 100, function () {}, { incrementX: false, incrementY: false });

• animateRotate
  (angles, duration,
  pause,
  callback, {parameters})

  animateRotate is similar to animateMove, and it provides an animated rotation. Note that animate Rotate optional parameter only has increment parameter that is set to true or false and that affect all axis.
  Ex: holomesh.animateRotate({x:0, y:0, z:1.5}, 700, 200, function(){});
  Ex2:holomesh.animateRotate({x:0, y:0, z: Math.PI/4 }, 700, 200, function(){});
  the rotation is in Radian, so Math.PI/4 is 45 degrees.
  
  
  

• animateFade
  (opacity, duration,
  pause,
  callback)

  animateFade is similar to animateMove, and it provides an animated opacity change.
  
  

• moveOnSpline
  (parameters,
  callback)

  Move the holomesh along a spline or a curve and returns a HoloSplineMovement object which has the methods start() and stop() to control the animation at any point. Start() is called implicitly upon calling moveOnSpline(). The function takes the following set of parameters:
  time — number. The time where you start the movement in a curve, a number between 0 and 1. Default is 0.
  counter — number. A percentage out of 1 of the number of steps in a single loop. the step counter is a number between 0 and 1. The higher the number the faster the movement. Default is 0.01
  interval — number. The number in milliseconds for each movement step, the lower the number the faster the movement. Default is 10.
  loop — boolean. If true, the movement will repeat otherwise it will run once. Default is true.
  spline — HoloCurve. The curve that the movement will follow.
  
  Example: var curve = new HoloBuild.HoloLineCurve3(new HoloBuild.HoloVector3(-0.1, 0, 0),new HoloBuild.HoloVector3(-0.05, 0.15, 0));
  mesh.moveOnSpline({counter: 0.001, loop: true, spline: curve, interval: 10 }, function () {});
  
  This method can be chained with the following two methods for additional functionalities
  setFunction: sets a call back function that is called on each interval.
  clearFunction: clears the function set with setFunction.
  Example: mesh.moveOnSpline().setFunction(function () {console.log('moving');})
  
  You can also set the parameters of the spline movement by using the method: setParam({ parametername: parameterValue })
  Example: var moveOnSpline = mesh.moveOnSpline({counter: 0.001, loop: true, spline: curve, interval: 10 }, function () {});
  moveOnSpline.setParam({spline: newSpline});

• show ()

  Calling the Show methods will enable the renderer to render the HoloMesh on its next update. Note that the method Show will also affect the opacity of the mesh: it will reset the mesh opacity to 1. If you don't want the opacity to be affected, you can use visible to true instead.

• hide ()

  Calling the hide methods will hide the HoloMesh from the HoloSpace.

• dispose ()

  Calling the dispose methods will deallocate the HoloMesh from memory.

• add (object)

  Add a child object to the HoloMesh.

• clone ()

  Returns a clone of the HoloMesh.

• getObjectById (id)

  Searches through the HoloMesh's children and returns the object with a matching id.

• getObjectByName
  (name)

  Searches through the HoloMesh's children and returns the first object with a matching name.

• getObjectByProperty
  (propertyname)

  Searches through the HoloMesh's children and returns the first object with a matching propertyname.

• getWorldPosition ()

  Returns a vector representing the position of the HoloMesh in the world space.

• getWorldRotation ()

  Returns a vector representing the rotation of the HoloMesh in the world space.

• getWorldScale ()

  Returns a vector representing the scaling factors applied to the HoloMesh in the world space.

• getWorldDirection ()

  Returns a vector representing the direction of HoloMesh's positive z-axis in the world space.

• translateOnAxis (axis, distance)

  Translate or move the HoloMesh by a specific distance on an axis (x,y,z), by a specific distance. axis — HoloVector3. A HoloVector3 represent axis that you want to move on, normalized to 1.
  distance — unit. The distance you want to move.
  Example: this will move the mesh1 on its Y axis a distance of 0.1: HoloMesh1.translateOnAxis(new HoloBuild.HoloVector3(0,1,0), 0.1);

• remove (object)

  Removes a child object from the HoloMesh.

• toJSON ()

  Convert the HoloMesh to JSON format.

• showAdjust
  ({PARAMETERS})

  Once the showAjdust method is called, a helper box will be drawn on top of the attached HoloMesh to allow the user to manipulate the object. Manipulation of the mesh includes: moving, rotating, and scaling the mesh. You set which manipulation capabilities you want the user to be allowed to do by setting the parameters as follows:
  rotate — Boolean. True will enable the vertical and horizontal rotation of a mesh. Default is true.
  rotateVertical — Boolean. True will enable the vertical rotation of a mesh. Default is true.
  rotateHorizontal — Boolean. True will enable the horizontal rotation of the mesh. Default is true.
  scale — Boolean. True will enable the scaling of the mesh. Default is true.
  move — Boolean. True will enable the moving of the mesh. Default is true.
  done — Boolean. True will enable a done button to be shown with the adjust controls, false will not show the done button. Default is true.
  

• animationClip
  (clipname)

  animationClip is a special method that loads the animation clips available for the mesh using the clip name. This method returns an instance of the HoloAnimation class that includes the following methods to manage an animation clip:
  run() — a method to start running the animation.
  pause() — a method to pause the animation.
  stop() — a method to stop the playing animation.
  reset() — a method to reset the playing animation.
  isRunning() — a method that returns true if the action is running.
  isEnabled() — a method that returns true for the current clip.
  setEffectiveTimeScale(number) — a method to set the timescale of the clip: 0 will pause the animation, a positive number will play the animation and a negative will paly it backward.
  fadeIn(time) — a method to fade in the playing animation by a time in seconds.
  fadeOut(time) — a method to fade in the playing animation by a time in seconds.
  crossFadeFrom(clip, time, warp) — a method to fade in a clip and fade out another clip within a time (wrap is a boolean if set to true will wrap the animation from one to the other).
  crossFadeTo(clip, time, warp) — a method to fade out a clip and fade out to another clip within a time (wrap is a boolean if set to true will wrap the animation from one to the other).
  startAt(time) — a method to start the animation at a given numeric time in seconds.
  repetitions — Number. a property that represents the number of times we want to see the same animation happening. The default is set to infinity, so it keep the animation happening forever.
  clampWhenFinished — Boolean. When we set clampWhenFinished to true, it means that the animation will automatically stop at its last frame. By default, it's set to false, so the animation restart after reaching the end.
  

• addIndicator
  ({PARAMETERS});

  Sometims a HoloMesh is outside of the user's field of view, or occlude by real world objects, and it is important to make it easier for the user to find that HoloMesh. You can use the addIndicator method which will show in the form of a directional arrow, or your own holomesh object, in order to alert the user to that important content and provide guidance related to the user's position.
  The directional indicator will appear when the user is looking away from the HoloMesh. The arrow like direction indicator will point the user toward the HoloMesh, if it is away from the user's view and away to a specific distance you can specify.
  This function takes an array of Parameters:
  distance — The indicator will continue to show until the minimum distance in meter to the HoloMesh is reached. Default
  color — By default the indicator is an arrow, you can change the default cursor color by specifying the color parameter. Default: 'red'
  object — This own HoloMesh object that you can use as a direction indicatory (optional).
  

• removeIndicator();

  Removes the direction indicator that was already set on that HoloMesh (see addIndicator for more information).

• tapToPlace
  (objTap, callback,
  {parameters});

  This method is used when you want to position a mesh according to another tagged along mesh. It is useful when you start a scene and you want the user to select where to position their mesh.
  objTap HoloMesh- The tagged along mesh (usually a button that the user will tap on to place a mesh).
  callback Function- The callback function to be called when the tagged along mesh is tapped.
  parameters set of parameters: onSurface (boolean - if true the object must be placed on a surface), position (vector3 - default tag along position).
  Example: MainMesh.tapToPlace(btnTaptoPlace, undefined, {position: new HoloBuild.HoloVector3(0,0,1)});

• placeOnObject
  (mesh, targetObj,
  {parameters});

  This method is used when you want to position a mesh on an object and according certain parameters.
  mesh HoloMesh- The mesh you want to place.
  targetObject HoloMesh/Hologroup- The target object.
  parameters set of parameters: axis (char - the axe you want to position: 'x', 'y', 'z'), rotate (boolean - whether to rotate the mesh or not).
  Example: this.placeOnObject(mesh, planeMeshD, { rotate: true, axis: 'y' });

• setParam
  ({ parametername:
  parameterValue })

  Set HoloMesh's parameters. Taking the parameter name and parameter value. (Currently only supporting the isCollab parameter).
  Example: holomesh.setParam({isCollab: true});

Constructor

• {PARAMETERS}

  A set of parameters containing a name and a value:
  isCollab: boolean. Specify whether the group interactability is propagated through the HoloCollab component or not. Default is false.

Properties

• children

  Returns an array of the HoloGroup's children.

• id

  A unique HoloGroup numeric identifier (readonly).

• name

  Represent the HoloGroup's name.

• parent

  Represent the HoloGroup's parent.

• position

  Represent the HoloGroup's local position.

• rotation

  Represent the HoloGroup's local rotation (in radians).

• scale

  Represent the HoloGroup's local scale.

• holoType

  Returns the type of this object. Example: Group.

• userData

  An object that could be used by developers to store their own custom data about the HoloGroup.
  Note: It should not hold references to functions.
  Example: holoGroup.userData = { propertyname: “property value” };
  And to use the property: holoGroup.userData.propertyname;

• visible

  if set to false the HoloGroup would not get rendered.

• onTap
  = callbackfunction

  The callbackfunction that is called on a tap event: a combination of user gaze on any child mesh of the HoloGroupand hand presses and releases gesture. Other ways for the onTap function to be called is by pressing the button on a HoloLens Clicker or by speaking the voice command "Select".
  the tap even will be called for the HoloGroup and the HoloMesh that was tapped (only one level up and down). Note: for the onTap event to work, the object hotspot parameter must be set to true.

Methods

• add (object)

  Add a child object to the HoloGroup.

• clone ()

  Returns a clone of the HoloGroup.

• getObjectById (id)

  Searches through the HoloGroup's children and returns the object with a matching id.

• getObjectByName
  (name)

  Searches through the HoloGroup's children and returns the first object with a matching name.

• getObjectByProperty (propertyname)

  Searches through the HoloGroup's children and returns the first object with a matching propertyname.

• getWorldPosition ()

  Returns a vector representing the position of the HoloGroup in the world space.

• getWorldRotation ()

  Returns a vector representing the rotation of the HoloGroup in the world space.

• getWorldScale ()

  Returns a vector representing the scaling factors applied to the HoloGroup in the world space.

• getWorldDirection ()

  Returns a vector representing the direction of HoloGroup's positive z-axis in the world space.

• setTagAlong(boolean, distance)

  if set to true, the HoloGroup will never fully leaves the user's view. it will act as if it is attached to the user's head by rubber bands: When the user moves, the content will stay in his view. The distance paramerts is an optional parameter that specify how far the HoloGroup is from the user. The distance is a HoloVector3: var tagAlongDistance = new HoloBuild.HoloVector3(0,0,0.5);

• remove (object)

  Removes a child object from the HoloGroup.

• toJSON ()

  Convert the HoloGroup to JSON format.

• show ()

  Calling the Show method will enable the renderer to render the HoloGroup on its next update. Note that the method Show will also affect the opacity of the group: it will reset the mesh opacity to 1. If you don't want the opacity to be affected you can use visible to true instead.

• hide ()

  Calling the hide methods will hide the HoloGroup from the HoloSpace.

• showAdjust
  ({PARAMETERS})

  Once the showAjdust method is called, a helper box will be drawn on top of the attached HoloGroup to allow the user to manipulate the group. Manipulation of the group includes moving, rotating, and scaling the group. You set which manipulation capabilities you want the user to be allowed to do by setting the parameters as follows:
  rotate — Boolean. True will enable the vertical and horizontal rotation of a group. Default is true.
  rotateVertical — Boolean. True will enable the vertical rotation of a group. Default is true.
  rotateHorizontal — Boolean. True will enable the horizontal rotation of the group. Default is true.
  scale — Boolean. True will enable the scaling of the group. Default is true.
  move — Boolean. True will enable the moving of the group. Default is true.
  

• hideAdjust ()

  Once the hideAjdust method is called, the helper box shown in the showAdjust will be forces to be hidden. The user adjust changes will be committed.

• tapToPlace
  (objTap, callback,
  {parameters});

  This method is used when you want to position a hologroup according to another tagged along mesh. It is useful when you start a scene and you want the user to select where to position their group.
  objTap HoloMesh- The tagged along mesh (usually a button that the user will tap on to place a group).
  callback Function- The callback function to be called when the tagged along mesh is tapped.
  parameters set of parameters: onSurface (boolean - if true the object must be placed on a surface), position (vector3 - default tag along position).
  Example: MainGroup.tapToPlace(btnTaptoPlace, undefined, {position: new HoloBuild.HoloVector3(0,0,1)});

• dispose ()

  Calling the dispose methods will deallocate the HoloGroup from memory.

Constructor

• name

  
  The label's name. It should be a unique name in your application.

• text

  The text to be displayed.
  text — String. One line text.
  OR
  text — Array of Strings. Multi-line text.
  

• {PARAMETERS} optional

  An object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.015 meters.
  color — Color. The text color. Default is set to 0x101010.
  width — Float. The label width. Default is set to 0.08.
  padding — Float. The text padding to its background. Default is 0.02.
  bgColor — Color. The text background color. Default is transparent.
  borderColor — Color. The label border color. Default is transparent.
  rounded — Boolean. If true, the HoloLabel will be rounded. Default is set to false.
  hotspot — Boolean. If true, the cursor will intersect with the HoloLabel. Default is set to true.
  align — String. ('left', 'right', 'center'). the label text will be aligned accordingly. Default is set to center. The width parameter needs to be filled for the left or right alignment to work.
  material: String. Specify the material type used in the control mesh, the options are 'basic', 'standard', or 'phong'. Default is basic.
  isCollab: boolean. Specify whether the label interactability is propagated through the HoloCollab component or not. Default is false.
  

Methods

• setText(text,
  {PARAMETERS})

  Set or Change the HoloLabel text to text
  text — String. One line text.
  OR
  text — Array of Strings. Multi-line text.
  PARAMETERS is an optional object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.015 meters.
  color — Color. The text color. Default is set to 0x101010.
  align — String. ('left', 'right', 'center'). the label text will be aligned accordingly. Default is set to center. The width parameter needs to be filled for the left or right alignment to work.
  

• getText()

  Return the HoloLabel text as a string.

• getHeight()

  Return the HoloLabel current height.

• setParam
  ({ parametername:
  parameterValue })

  Set any of the HoloLabel's parameters. Taking the parameter name and parameter value.
  Example: setParam({ text: 'NewText', color: 0xFF0000});

Constructor

• name

  The HoloButton Name. It should be a unique name in your application.

• width

  The HoloButton width. As a general rule the minimum width of a button should not be less than 0.032 (or 3.2 cm).

• height

  The HoloButton height. As a general rule the minimum height of a button should not be less than 0.032 (or 3.2 cm).

• depth

  The HoloButton depth, 0 for a plane geometry and > 0 for a box geometry.

• {PARAMETERS} optional

  An object that can contain the following parameters:
  bgColor — String Hex Color. Background button color. Default is 0x3c3c3c.
  bgTransparent — Boolean. If set to true, the button will have a transparent background. Default is false.
  bgShape — String. Options are 'circle' and 'square'. Default is 'square'.
  borderColor — String Hex Color. Border color that will be shown when the button is clicked.
  borderThickness — Float. Border thickness in pixels that will be shown when the button is clicked. Default is 3 pixels.
  borderGap — Boolean. Specify whether the border should be offset a little into the button or not. If set to true(default value) the border will be drawn inside the button by a very small offset.
  hoverState — Boolean. Whether a hover effect is available or not. Default is true.
  hoverBorderColor — String Hex Color. Hover border color that will be shown when the button is hovered.
  hoverBorderThickness — Float. Hover border thickness in pixels that will be shown when the button is hovered. Default is 3 pixels.
  clickState — Boolean. Whether a click effect is available or not. Default is true.
  clickBorderColor — String Hex Color. Click border color that will be shown when the button is clicked.
  clickBorderThickness — Float. Click border thickness in pixels that will be shown when the button is clicked. Default is 4 pixels.
  image — String. Image filename that will show as the button background.
  imageSize — {width, height}. Image size that will set the image size {width, height}. Default is the button size so the image will stretch to fit the button.
  imageAlign: The button's image position: HoloBuild.AlignCenterLeft, HoloBuild.AlignCenter, HoloBuild.AlignCenterRight, HoloBuild.AlignTopLeft, HoloBuild.AlignTopCenter, HoloBuild.AlignTopRight, HoloBuild.AlignBottomLeft, HoloBuild.AlignBottomCenter, HoloBuild.AlignBottomRight . Default is HoloBuild.AlignCenter.
  text The button's text. Default is null.
  fontSize The button's text font size. Default is 0.015 meters.
  fontColor The button's text font color. Default is 0xFFFFFF.
  fontWeight The button's text font weight. Default is 'normal'.
  textAnchor: The button's text position: HoloBuild.AlignCenterLeft, HoloBuild.AlignCenter, HoloBuild.AlignCenterRight, HoloBuild.AlignTopLeft, HoloBuild.AlignTopCenter, HoloBuild.AlignTopRight, HoloBuild.AlignBottomLeft, HoloBuild.AlignBottomCenter, HoloBuild.AlignBottomRight . Default is HoloBuild.AlignCenter.
  soundMute — Boolean. if set to true will disable the spatial sound that will be played when a user tap on the button.
  sound — String. the filename of the sound file that will be played when a user tap on the button.
  material: String. Specify the material type used in the control mesh, the options are 'basic', 'standard', or 'phong'. Default is standard.
  isCollab: boolean. Specify whether the button interactability is propagated through the HoloCollab component or not. Default is false.
  

  To create your button image, use the Selawik Regular font for consistency and the following PSD file for buttons icons icons.psd For the icon set used by the Hololens, use the following fonts to create your images: holomdl2.ttf and HoloSymMDL2.ttf

Methods

• setEnabled();

  This method will either disable the button or enable it. If the button is disabled, it cannot take any user interaction.

• setText(text,
  {PARAMETERS});

  Set or Change the HoloButton text value.
  PARAMETERS is an optional object that can contain the following parameters:
  fontSize The button's text font size. Default is 0.015 meters.
  fontColor The button's text font color. Default is 0xFFFFFF.
  fontWeight The button's text font weight. Default is 'normal'.
  textAnchor: The button's text position: HoloBuild.AlignCenterLeft, HoloBuild.AlignCenter, HoloBuild.AlignCenterRight, HoloBuild.AlignTopLeft, HoloBuild.AlignTopCenter, HoloBuild.AlignTopRight, HoloBuild.AlignBottomLeft, HoloBuild.AlignBottomCenter, HoloBuild.AlignBottomRight . Default is HoloBuild.AlignCenter.
  

• getText()

  Return the HoloButton text. text — String. Button text.
  

• setVoiceCommand(command,toolTip)

  Set the button's voice command, when the voice command is said by the user, the button is tapped.
  Command- String. The cvoice command to attach to the button.
  toolTip- Boolean. Specify whether a tooltip should appear when the user gazes at the button explaining the availability of the voice command.

• clearVoiceCommand()

  Clears the button's voice command.
  

• setParam
  ({ parametername:
  parameterValue })

  Set any of the HoloButton's parameters. Taking the parameter name and parameter value.
  Example: setParam({ text: 'NewText', color: 0xFF0000});

Constructor

• name

  The HoloSwitch Name. It should be a unique name in your application.

• width

  The HoloSwitch width.

• height

  The HoloSwitch height.

• depth

  The HoloSwitch depth, 0 for a plane geometry and > 0 for a box geometry.

• {PARAMETERS} optional

  An object that can contain the following parameters:
  bgColor — String Hex Color. Background button color. Default is 0x3c3c3c.
  borderColor — String Hex Color. Border color that will be shown when the button is clicked.
  borderThickness — Float. Border thickness in pixels that will be shown when the button is clicked. Default is 3 pixels.
  hoverState — Boolean. Whether a hover effect is available or not. Default is true.
  hoverBorderColor — String Hex Color. Hover border color that will be shown when the button is hovered.
  hoverBorderThickness — Float. Hover border thickness in pixels that will be shown when the button is hovered. Default is 3 pixels.
  clickState — Boolean. Whether a click effect is available or not. Default is true.
  clickBorderColor — String Hex Color. Click border color that will be shown when the button is clicked.
  clickBorderThickness — Float. Click border thickness in pixels that will be shown when the button is clicked. Default is 4 pixels.
  imageSize — {width, height}. Image size that will set the image size {width, height}. Default is the button size so the image will stretch to fit the button.
  imageAlign: The button's image position: HoloBuild.AlignCenterLeft, HoloBuild.AlignCenter, HoloBuild.AlignCenterRight, HoloBuild.AlignTopLeft, HoloBuild.AlignTopCenter, HoloBuild.AlignTopRight, HoloBuild.AlignBottomLeft, HoloBuild.AlignBottomCenter, HoloBuild.AlignBottomRight . Default is HoloBuild.AlignCenter.
  text The button's text. Default is null.
  fontSize The button's text font size. Default is 0.015 meters.
  fontColor The button's text font color. Default is 0xFFFFFF.
  fontWeight The button's text font weight. Default is 'normal'.
  textAnchor: The button's text position: HoloBuild.AlignCenterLeft, HoloBuild.AlignCenter, HoloBuild.AlignCenterRight, HoloBuild.AlignTopLeft, HoloBuild.AlignTopCenter, HoloBuild.AlignTopRight, HoloBuild.AlignBottomLeft, HoloBuild.AlignBottomCenter, HoloBuild.AlignBottomRight . Default is HoloBuild.AlignCenter.
  material: String. Specify the material type used in the control mesh, the options are 'basic', 'standard', or 'phong'. Default is standard.
  isCollab: boolean. Specify whether the stepper interactability is propagated through the HoloCollab component or not. Default is false.
  

  To create your button image, use the Selawik Regular font for consistency and the following PSD file for buttons icons icons.psd For the icon set used by the Hololensuse the following fonts: holomdl2.ttf and HoloSymMDL2.ttf

Methods

• toggle();

  This method will toggle the switch status: it will visually turn the switch on if it was off or the other way around.

• setEnabled();

  This method will either disable the button or enable it.

Constructor

• name

  The stepper's name. It should be a unique name in your application.

• value

  The stepper's value.

• width

  The stepper's width.

• {PARAMETERS} optional

  An object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.02 meters.
  color — The text color. Default is set to 0x101010.
  bgColor — The text background color. Default is 0xFFFFFF.
  padding — Float. The text padding to its background. Default is 0.02.
  min — Float. The lowest possible numeric value for the HoloStepper. Default is 0.
  max — Float. The highest possible numeric value for the HoloStepper. Default is 100.
  increment — Float. The increment, or step, value for the HoloStepper. Default is 1.
  isCollab: boolean. Specify whether the stepper interactability is propagated through the HoloCollab component or not. Default is false.
  

Constructor

• btnWidth

  The default button width.

• btnHeight

  The default button height.

• {PARAMETERS} optional

  vertical An optional Boolean value that if enabled will draw the HoloToolbar vertically. reverse An optional Boolean value that if enabled will draw the HoloToolbar in the reverse direction (from right to left). margin — Number. This number represent the margins between toolbar button in meters, the default is 0.005.

Methods

• addButton (name,
  {PARAMETERS})

  addButton will add a button to the toolbar with a specific name and a set of parameters: image — String. This is the image's filename that will show on the button.
  

• addSwitch (name,
  {PARAMETERS})

  addSwitch will add a switch to the toolbar with a specific name and a set of parameters:
  image — String. This is the image's filename that will show on the switch.
  groupRadio — Boolean. Specifies whether this switch follows the radioButton behaviour.
  groupName: — String. Group name used to group switches together.

• addSubToolbar
  (toolbarSub, btn,
  toggleMode);

  Add a child HoloToolBar to the main toolbar and link it to a specific button or switch. If a user taps on the linked button or switch, the subtoolbar will be automatically toggled. toggleMode is an enumerator that specificy the position of the sub toolbar: toggleMode elements include the following: toggleMode.LEFT, toggleMode.RIGHT, toggleMode.TOP, toggleMode.BOTTOM.

• reset();

  Resets the toolbar by turning off any switches and closing any subtoolbar.
  

• reverseOrder();

  Reverses the direction of the toolbar from LTR to RTL or the other way around.
  

• hideChild
  (controlname);

  Hides a HoloToolbar child by referencing the child name. This function is useful if you want to temporary hide one of the toolbar children without messing the button's spacing. You can use the showChild function to show back the child control.
  

• showChild
  (controlname);

  Shows a HoloToolbar hidden child by referencing the child name.
  
  

• getParent();

  Returns the toolbar parent button or switch if it exists.
  

Constructor

• name

  The HoloPanel name. It should be a unique name in your application.

• width

  The HoloPanel width.

• height

  The HoloPanel height.

• {PARAMETERS}

  bgColor The HoloPanel background color. Default is 0x3c3c3c.
  close A Boolean value that if set to true will show an X like button on top of the HoloPanel that will close the panel once the user tap on it.
  rounded A Boolean value specifying whether the panel will have rounded edges or not. material: String. Specify the material type used in the control mesh, the options are 'basic', 'standard', or 'phong'. Default is basic.
  

Methods

• addChild
  (object, pos);

  Add a child object to the panel. pos is the position of the child in respect to the panel.

• onClose
  = callbackfunction

  The callbackfunction that is called when the panel close button tap event.

• setHeight(height);

  Set or Change the HoloPanel height to height value.

Properties

• height

  Height of the panel.

• width

  Width of the panel.

Constructor

• name

  The HoloDialog name. It should be a unique name in your application.

• title

  The HoloDialog Title.

• text

  The HoloDialog text.

• PARAMETERS optional

  Optionally the HoloDialog can take other parameters as an object that can contain the following:
  mode — enumerator. The mode of the dialog: (dialogMode.DEFAULT, dialogMode.CONFIRM, or dialogMode.INFO). dialogMode.DEFAULT for a notification like dialog with a close button; dialogMode.CONFIRM for a confirmation like dialog with a YES and NO buttons; HB.Enum.dialogMode.INFO for an information only dialog without any buttons. Default is dialogMode.DEFAULT.
  bgColor — color. The HoloDialog background color. Default is 0x070707.
  titleColor — color. The HoloDialog title color. Default is 0xFFFFFF.
  titleBgColor — color. The HoloDialog title background color. Default is 0x1C1C1C.
  bodyColor — color. The HoloDialog body color. Default is 0xFFFFFF.
  bodyBgColor — color. The HoloDialog body background color. Default is 0x070707.
  titleAlign — String. ('left', 'right', 'center'). the HoloDialog title alignment. Default is left.
  bodyAlign — String. ('left', 'right', 'center'). The HoloDialog body alignment. Default is left.
  

• callbackfunction optional

  The callbackfunction is the call back function that will be called when the user performs an action on the HoloDialog. If the dialog mode is dialgMode.CONFIRM, the callback function will be called with one boolean argument. The boolean value will be true if the YES button is tapped, or false otherwsie.

Methods

• setText(text);

  Set or Change the HoloDialog text text value.

Constructor

• name

  The HoloCheckBox Name. It should be a unique name in your application.

• size

  A number denoting the HoloCheckBox width and height, it is one number since the checkbox has a square form.

• depth

  The HoloCheckBox depth, 0 for a plane geometry and > 0 for a box geometry.

• {PARAMETERS} optional

  An object that can contain the following parameters:
  bgColor — String Hex Color. Background button color. Default is 0x3c3c3c.
  bgTransparent — Boolean. If set to true, the checkbox will have a transparent background. Default is false.
  borderColor — String Hex Color. Border color that will be shown when the button is clicked.
  borderThickness — Float. Border thickness in pixels that will be shown when the button is clicked. Default is 3 pixels.
  hoverState — Boolean. Whether a hover effect is available or not. Default is true.
  hoverBorderColor — String Hex Color. Hover border color that will be shown when the button is hovered.
  hoverBorderThickness — Float. Hover border thickness in pixels that will be shown when the button is hovered. Default is 3 pixels.
  clickState — Boolean. Whether a click effect is available or not. Default is true.
  clickBorderColor — String Hex Color. Click border color that will be shown when the button is clicked.
  clickBorderThickness — Float. Click border thickness in pixels that will be shown when the button is clicked. Default is 4 pixels.
  image — String. Image filename that will show as the button's background.
  fontSize The button's text font size. Default is 0.015 meters.
  fontColor The button's text font color. Default is 0xFFFFFF.
  fontWeight The button's text font weight. Default is 'normal'.
  soundMute — Boolean. if set to true will disable the spatial sound that will be played when a user tap on the button.
  sound — String. the filename of the sound file that will be played when a user tap on the button.
  checked — Boolean. if set to true will have an X on the checkbox and its status to checked.
  symbol — Character. The checkbox character that will be shown when the user taps on the checkbox. the default is ✓
  

Property

• checked

  This property will return a boolean representing the checkbox status, true for checked and false for not checked.

Methods

• setEnabled();

  This method will either disable the button or enable it.

• setParam
  ({ parametername:
  parameterValue })

  Set any of the HoloCheckbox's parameters. Taking the parameter name and parameter value.
  Example: setParam({ color: 0xFF0000});

Constructor

• name

  
  The HoloText3D component name. It should be a unique name in your application.

• text

  The text to be displayed.
  text — String. One line text.
  OR
  text — Array of Strings. Multi-line text.
  

• {PARAMETERS} optional

  An object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.03 meters.
  color — Color. The text's color. Default is set to 0x101010.
  height — Float. The label's height. Default is set to 0.
  padding — Float. The text's padding to its background. Default is 0.02.
  hotspot — Boolean. If true, the cursor will intersect with the HoloText3D. Default is set to true.
  align — String. ('left', 'right', 'center'). the label text will be aligned accordingly. Default is set to center. The width parameter needs to be filled for the left or right alignment to work.
  

Methods

• setText(text,
  {PARAMETERS})

  Set or Change the HoloText3D text to text
  text — String. One line text.
  OR
  text — Array of Strings. Multi-line text.
  PARAMETERS is an optional object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.015 meters.
  color — Color. The text color. Default is set to 0x101010.
  align — String. ('left', 'right', 'center'). the label text will be aligned accordingly. Default is set to center. The width parameter needs to be filled for the left or right alignment to work.
  

• getText()

  Return the HoloText3D text as a string.

Constructor

• name

  
  The textbox name. It should be a unique name in your application.

• text

  The textbox default text (optional)
  

• {PARAMETERS} optional

  An object that can contain the following parameters:
  fontSize — Float. Size of the text (text height). Default is 0.015 meters.
  color — Color. The text color. Default is set to 0x101010.
  width — Float. The textbox width. Default is set to 0.1.
  height — Float. The textbox height. Default is set to 0.025.
  bgColor — Color. The text background color. Default is transparent.
  hotspot — Boolean. If true, the cursor will intersect with the HoloTextBox. Default is set to true.
  border — Boolean. If true, the HoloTextBox will have a border. Default is set to false.
  

Methods

• getText()

  Return the HoloTextBox text entered by the user as string.
  

• onExit
  = callbackfunction

  The callbackfunction that is called when the used exit the textboox keyboard.

Constructor

• callbackfunction

  The callback function that will be triggered when the slider value is changed.

• {PARAMETERS} optional

  An object that can contain the following parameters:
  width — Float. The slider width. Default is set to 0.1.
  range — Object. The minimum and maximum range of the slider in the form of {min:0, max:10}.
  increment — Float. The step value for the slider. Default is 1.
  knob — Object. The knob of the slider.
  

Methods

• getValue()

  Returns the current value of the HoloSlider as a float.
  

• setValue(value)

  Set the current value of the HoloSlider.

• setParam({PARAMETERS})

  Sets the parameters of the HoloSlider. Parameters include 'knob', 'increment', and 'material'.

Methods

• addVoiceCommand
  (command, callback);

  This method will add a voice command that the speech recognition system will monitor for. Once the command is recognized with a high confidence, the callback function will be called.
  command String- The voice command string that you want the system to recognize
  callback Function- The function that will be called once the system recognizes the command. An event object is added as an argument to the callback function, the event can return the command name: e.command
  

• updateVoiceCommand
  (command, callback);

  This method will update the callback function of an already defined voice command.
  command String- The voice command string that you want the recognizer to update
  callback Function- The new function that will be called once the system recognizes the command
  

• deleteVoiceCommand
  (command);

  This method will delete an already set voice command.
  command String- The voice command string that was set with the addVoiceCommand function.
  

• resetVoiceCommand
  ();

  This method will remove all the voice commands that are already set.
  

• setConfidence (level);

  This method will update how confident the system is before calling the callback function.
  level Float- The minimum level of confidence to recognize a command. Default is 0.5
  

• addTriggerCommand
  (trigger,
  {PARAMETERS});

  This method will add a trigger command that the user will have to say before commands are accepted. The trigger is any word. Example: HoloBuild.HoloSpeechRecognition.addTriggerCommand('alex'); Once set, the user has to say the trigger command before any voice command he wants to use. The function also take a parameter: timeout in millisecons, once set the trigger will stay active to take multiple commands at the same time until the timeout expires.
  

• removeTriggerCommand
  (trigger);

  This method will remove an already set trigger command. Example: HoloBuild.HoloSpeechRecognition.removeTriggerCommand('active');
  

• setFailedMessage
  (message);

  This method will set the audio message played when recognized commands have a lower confidence than the set value (default is 0.5). This only applies for when a trigger command is set. Example: HoloBuild.HoloSpeechRecognition.setFailedMessage('please repeat');
  

Properties

• onSpeech
  = callback(result).

  callback function that executes when speech is detected using the microphone. Result is an object with 2 properties:
  text:- String representing the detected text.
  confidence:- integer representing the corresponding confidence level.

Methods

• start()

  Start the speech detection component.

• stop()

  Stop the speech detection component.

• setConfidence(lvl)

  lvl:-Float. Set confidence level to lvl which is a number between 0 and 1.

Constructor

• filename

  String - The sound file name that you want to load.
  Note: alternatively you can provide a url of the sound file to load the sound remotely (make sure to use PlayWhenReady function to play remote files as you don't know when they will be loaded.).

Properties

• offset

  Number - set the number of seconds that you want to start playing the audio from. Default is 0.

Methods

• play()

  play the sound file. Note: you can only play a sound if it is Loaded. Use PlayWhenReady if you the sound to autoplay when loaded.

• isLoaded()

  A property that returns a boolean denoting if the audio file is loaded or not.

• playWhenReady()

  play the sound file as soon as it becomes loaded. This method is useful for a large audio file that you do not know how much time it will take to be load to the buffer.

• pause()

  Pause the sound play.

• stop()

  Stop the playing sound.

• isPlaying

  A property that returns a boolean denoting if the audio is currently playing or not.

• onEnded = callbackFct

  calls the callbackFct when the sound playing is finished. Example: Audio.onEnded = function(){console.log('audio ended')};

Constructor

• {PARAMETERS}

  parameters to fetch a specific voice. A default voice will be used if no parameters are passed. You can use the getVoices() method to get the information about different voices.
  name: name of the voice.(optional)
  locale: accent of the voice.(optional)

Methods

• getVoices
  (callback)

  Method to fetch information about available voices.
  

• getSpeech
  (text)

  Method that returns a SpatialSound. Which you can then play by calling playWhenReady(). (See example)

Constructor

• {PARAMETERS}

  markerType string. The type of the marker you want to track. The current supported types: "qr" for tracking QR codes, or "aruco" to track Aruco Markers.
  markerSize float. The size of the marker size in mm to track. All the markers in the scene should be of the same size, otherwise the positioning will be off. Default markersize is 0.038.
  Note: To create Aruco markers, you can use the following link http://chev.me/arucogen/ (Select the original marker type).

Methods

• Start
  (callback(result))

  This function will start detecting markers in your scene using the device's camera. The default camera used is the device's front camera, if not available, the first available camera will be used. It will continue detecting markers until you specifically call the Stop function.
  callback(result)- Function: this function is called when a marker is detected. Result is an array containing marker objects with the following properties:
  -id: Marker id
  -translation: a vector3 representing the position of the marker (the center of the marker)
  -rotation: a vector 3 representing the rotation of the marker.

• Stop()

  This function stops the detection process of the markers.

Methods

• loadAnchor
  (object, anchorname,
  callback(success) )

  load a saved anchor position, with the name anchorname, and place an object on that position.
  object - Object : the hologram whose anchor is to be saved. anchorname - String : the anchor's name. It should be a unique name in your application. callback(success) - Function : a callback function that will be called when load anchor completes it task, success is a boolean that will be set to true if the anchor is loaded successfully.

• setAnchor
  (object, anchorname,
  callback(success) )

  Save an anchor, with the name anchorname, and get the anchor position and rotation from the object.
  object - Object : the hologram whose anchor is to be saved. anchorname - String : the anchor's name. It should be a unique name in your application. callback(success) - Function : a callback function that will be called when set anchor completes its task, success is a boolean that will be set to true if the anchor is set successfully.

• deleteAnchor
  (anchorname, callback(success) )

  delete a saved anchor, with the name anchorname.
  anchorname - String : the anchor's name. callback(success) - Function : a callback function that will be called when delete anchor completes its task, success is a boolean that will be set to true if the anchor is deleted successfully.

Methods

• start
  ({PARAMETERS})

  displays a panel that shows the 'quality' of the scan.This panel has a "start scan" to allow the user to start the scan whenever they're ready. This button turns to an 'end scan' button when a minimum sufficient quality is reached to allow the user to end the scan. Callback functions for these events can be added if needed(See Properties section below). In addition to the spatial map created, the start() method, analyzes the environment and returns the various surfaces found.
  Parameters include:
  occlusion: Boolean to specify whether you want the holograms in the scene to get occluded when they're further away from the user than real surfaces.
  autofinsih: Boolean to specify whether the scan should automatically finish when the scan reaches a sufficient level of quality specified by the parameteres 'minFloorPct', 'minWallPct', and 'minPlatformPct'.
  room: Parameters for the mesh shown to the user while scanning. These parameters include:visible: Boolean specifying if the mesh is visible or not.wireframe: Boolean specifying if the mesh is a wireframe mesh or not.
  minFloorPct: Float to specify the sufficient percentage of found floors before the user is allowed to end the scan or before the scan ends automatically in the case where the 'autofinish' parameter is set to true.
  minWallPct: Float to specify the sufficient percentage of found walls before the user is allowed to end the scan or before the scan ends automatically in the case where the 'autofinish' parameter is set to true.
  minPlatformPct: Float to specify the sufficient percentage of found platforms before the user is allowed to end the scan or before the scan ends automatically in the case where the 'autofinish' parameter is set to true.
  panel: Boolean. Specify whether the panel should appear to the user or if the scan should start and end automatically according to the 'minFloorPct', 'minWallPct', and 'minPlatformPct' parameters.
  

• findPositionsOnWalls
  ({PARAMETERS})

  returns an array of center positions of wall surfaces in the spatial environment, based on the parameters(constraints) specified. These surfaces have a 'center' property and a 'normal' property. PARAMETERS: a set of constraints to filter the returned positions. These params include:
  resultCount: Integer. Limit the number of results returned in the array. Default is null.
  minHeightOfWallSpace: Float. Minimum allowed height of a recognized wall(vertical surface). Any surface with height less than the minimum will not be returned in the array. Default is 0.5.
  minWidthOfWallSpace: Minimum allowed height of a recognized wall. Default is 0.5.
  minHeightAboveFloor: Float. Minimum distance above floor of a recognized wall. Default is 0.1 .
  minFacingClearance: Float. Minimum allowed distance between a recognized wall and a facing surface. Default is 0.1 .

• findPositionsOnPlatforms
  ({PARAMETERS})

  returns an array of center positions of Platform surfaces in the spatial environment, based on the parameters(constraints) specified. These surfaces have a 'center' property and a 'normal' property. Platforms are flat, horizontal surfaces in the room (excluding floor and ceiling). PARAMETERS: a set of constraints to filter the returned positions. These params include:
  resultCount: Integer. Limit the number of results returned in the array. Default is null.
  minHeight: Float. Minimum allowed distance from the floor of a recognized platform. Default is 0.125.
  maxHeight: Float. Maximum allowed distance from the floor of a recognized platform . Default is 1.0 .
  minFacingClearance: Float. Minimum allowed distance between a recognized platform and a facing surface. Default is 0.1 .

• findPositionsOnFloors
  ({PARAMETERS})

  returns an array of center positions of Floor surfaces in the spatial environment, based on the parameters(constraints) specified. These surfaces have a 'center' property and a 'normal' property. PARAMETERS: a set of constraints to filter the returned positions. These params include:
  resultCount: Integer. Limit the number of results returned in the array. Default is null.
  minLength: Float. Minimum allowed length of a floor surface. Default is 0.5.
  minWidth: Float. Minimum allowed width of a recognized floor. Default is 0.5.

• findLargestWall
  ()

  returns the largest wall surface found in the room. In addition to the 'center' and 'normal' properties, this returned object has 'width' and 'length' properties.

• placeObject
  (mesh, onSurfaceType, {PARAMETERS})

  Places the mesh on a random surface. mesh: HoloMesh. The mesh affected.
  onSurfaceType: String. Options are "OnCielling" , "OnEdge", "OnWall", "OnFloor".
  {PARAMETERS} : faceSurface Boolean specifying whether the mesh should be rotated to face the normal of the surface.

Properties

• onEnd
  = callback

  function to execute when the user taps on the 'end scan' button.

• onMinimumReached
  = callback

  function to execute when the scan reached the specified minimum quality. Note that this event happens before the user taps on the 'end Scan' button.

Constructor

• {PARAMETERS}optional

  An object that can contain the following parameters:
  mode — Enumerator. Set the connection mode: collaboration mode, is the mode that all users can interact in the shared experience. Presentation mode, is a mode that only the connection that is set to Master is able to interact in the shared experience (using setMaster method). Possible enumarator values HoloBuild.collabMode.collaboration for collaboration mode and HoloBuild.collabMode.presentation for presenation mode. Default is collaboration mode.
  showIndicator — Boolean. If set to true it shows an indicator to the user if the connection is established. Default is false.
  mode: showIndicator: boolean

Properties

• name

  a property for the user to set a name for this connection, this name is used to show over the user's head if set.

• clientId

  a property that returns the connection client Id, a unique identifier for each connections (readOnly).

Methods

• connect
  (callback())

  Connects the HoloLens to the BuildWagon Server that manages the rooms. Callback for when the connection is established.

• joinRoom
  (name)

  Connects the HoloLens to a specific room on the server. If no room with that name exists, a new room is created. Callback for when the room is created and the connection is established.

• on
  (msgName, callback())

  Sets a callback function to be executed when a message with the name 'msgName' is emitted to the room.

• emit
  (msgName , msgData)

  Emits a message to the room with the name 'msgName' containing msgData. Data sent can be any javascript object or primitive data type. Data is received as a string by other devices.

• setMaster()
  (callback())

  Set this connection type to a master connection.

• unsetMaster()
  (callback())

  Unset this connection type to a regular connection.

• getClients()
  (callback(clients))

  getClients call back a function with an array of object for the current room connected clients. The array returns also each connected clientId, name, room, and isMaster (whether the connection type is a master connection or not).

• disconnect
  (callback())

  Disconnect the HoloLens from the BuildWagon Server. Callback for when the connection is disconnected.

Methods

• getObjectByPropertyName
  (propertyname);

  This method is used when you want to return an object by a specific property name.
  
  propertyname: string - the name of the property you are looking for.
  

• getArrayObjectsByProperty
  (array, property, value);

  This method searches an array for all objects with a matching property value, returning an array of the matched objects.
  
  array: Array - the array to be searched
  property: String - the property to search for
  value: String - the property value to search
  

• getGroupObjectsByProperty
  (propertyname);

  This method searches a group for all objects with a matching property value, returning an array of the matched objects.
  
  group: HoloGroup - the group to be searched
  property: String - the property to search for
  value: String - the property value to search
  

• recalculateUVs
  (geometry);

  This method calculates uvs vectors of a geometry.
  
  
  

• getSnapshot
  (callback(image));

  This method takes a snapshot from the device camera and return the result as an image element.
  
  
  

• getDeviceInfo()
  

  This method returns device information. The function return an object containing device related informtion. For example, the returned object contains the name property that holds the device name. Possible values for name: 'Hololens', or 'HoloLens 2', or 'emulator'.
  
  
  

Methods

• setDebug
  (showDebug);

  This method will either enable or disable showing the console log information on your Hololens. The information will be show next the buildWagon version number.
  showDebug Boolean- If true the debug information will be displayed. Default is false.
  

• setLoading
  (boolean);

  This method will either enable or disable showing the loading indicator. The loading indicator appears whenever an asset is being loaded over the network.
  

Properties

• currentPoint

  Represents the starting point of reference for drawing any curve. Before calling any of the drawing functions below, currentPoint is {x:0 , y:0}.

Methods

• moveTo(x ,y)

  float x, y.
  Changes the current reference point (a.k.a. currentPoint) to the point p{x:x, y:y}.

• lineTo(x ,y)

  float x, y.
  Draws a line from currentPoint to the point p(x,y).

• quadraticCurveTo
  (cpX, cpY, x, y).

  float cpX, cpY, x, y.
  Draws a quadratic curve from the currentPoint to the point p(x,y) with point cp(cpX, cpY) as a control point.

• bezierCurveTo
  (cp1X, cp1Y, cp2X,
  cp2Y, x, y).

  float cp1X, cp1Y, cp2X, cp2Y, x, y.
  Draws a Bezier curve from currentPoint to the point p(x,y) with points cp1(cp1X, cp1Y) and point cp2(cp2X, cp2Y) as control points.

• absarc
  (x, y, radius,
  startAngle, endAngle,
  clockWise).

  float x, y, radius, startAngle, endAngle.
  boolean clockWise.
  Draws an arc with center c(x,y) and with the specified parameters.

• absellipse
  (x, y, xRadius,
  yRadius, startAngle,
  endAngle, clockWise, rotation).

  float x, y, xRadius, yRadius, startAngle, endAngle, rotaion.
  boolean clockWise.
  Draws an arc with center c(x,y) and with the specified parameters. Rotation is the rotation angle of the ellipse around the x-axis.

Types of Curves

• Line Curve

  HoloLineCurve3(HoloVector3, HoloVector3):
  Creates a curve made up of 2 points.

• Bezier Curve

  QuadraticBezierCurve3(HoloVector3, HoloVector3, HoloVector3):
  Creates a curve made up of 3 points.

• Cubic Bezier Curve

  HoloCubicBezierCurve3(HoloVector3, HoloVector3, HoloVector3, HoloVector3):
  Creates a curve made up of 4 points.

• Catmull Rom Curve

  HoloCatmullRomCurve3([HoloVector3]):
  Creates a curve made up of multiple points (takes an array of HoloVector3.

Methods

• getPoints(n)

  n - integer: specify the number of points to return from the created curve.

Methods

• saveData
  (key, obj, callback)

  use this method to save data to the HoloDB. Note that the obj can not be more than 64 KB.




• retrieveData
  (key, callback)

  use this method to query data from the HoloDB using key, the callback function(data) returns the data in the callback function parameter.




• deleteData
  (key , callback)

  use this method to delete data from the HoloDB using key, the callback function will be called with the deletion status.

Method

• load('file url',clbk())
  

  The method load a file and return a callback function with the file content when the file is loaded.

Method

• load('image url',clbk())
  

  The method load an image that the texture is based on and return a callback function with the texture when the image is loaded.

Properties

• mapping

  The texture mapping mode: HoloBuild.UVMapping is the default. HoloBuild.EquirectangularReflectionMapping for background map representing a 360 view.

• wrapS

  The texture wrapping horizontally: number

• wrapT

  The texture wrapping vertically: number

• format

  The texture format: HoloBuild.RGBAFormat (red, green, blue, and alpha).

Properties

• height

  The height of the canvas in pixels.

• width

  The width of the canvas in pixels.

• ctx.fillStyle

  sets the contexts filling color.

• ctx.strokeStyle

  sets the contexts stroking color.

• ctx.lineWidth

  sets the contexts line width. Default is 1.0 .

• ctx.lineCap

  Specifies the shape of a line endings. Options include: "butt", "line", "square"

• ctx.lineJoin

  Specifies the shape when two lines join. Options include: "round", "bevel", "miter"

• ctx.miterLimit

  sets the contexts miter limit ratio. Default is 10.

• ctx.font

  sets the contexts fonts

• ctx.textAlign

  sets the contexts text alignment setting. Options include: "end", "right", "center", "middle".

• ctx.textAlign

  sets the contexts baseline alignment setting. Options include: "bottom".

• ctx.shadowBlur

  sets the contexts blurring effect. Default is 0.

• ctx.shadowColor

  sets the contexts shadow color. Default is transparent black.

• ctx.shadowOffsetX

  sets the contexts horizontal distance offset of the shadowing effect. Default is 0.

• ctx.shadowOffsetY

  sets the contexts vertcal distance offset of the shadowing effect. Default is 0.

• ctx.globalAlpha

  Alpha value(transparency) applied to an object to be drawn. Default is 1.

Methods

• getContext("2d")

  This method will return a 2 dimensional drawing context, which you can then use to call the drawing methods.

• ctx.clearRect
  (x, y, w, h)

  Clears all the pixels in the rectangle with width w and height h, starting from pixel (x,y). Cleared pixels are set to transparent black.

• ctx.fillRect
  (x, y, w, h)

  Fills all the pixels in the rectangle with width w and height h, starting from pixel (x,y) with a preset colour. To set the colour, you have to set the context's fillStyle property to that colour (i.e. ctx.fillStyle).

• ctx.fillText
  (text, x, y)

  Writes the given text starting at pixel (x,y).

• ctx.measureText
  (text)

  Returns width in pixels of the given text.

• ctx.createLinearGradient
  (x1, y1, x2, y2)

  This returns a gradient which you can then assign to the contexts 'fillStyle' and 'strokeStyle' properties. the returned gradient object has a function addColorStop(offset, color) to add stops to the gradient.

• ctx.createRadialGradient
  (x1, y1, r1, x2, y2, r2)

  This returns a gradient which you can then assign to the contexts 'fillStyle' and 'strokeStyle' properties. the returned gradient object has a function addColorStop(offset, color) to add stops to the gradient.

• ctx.beginPath()

  Begins a new drawing path.

• ctx.closePath()

  closed the drawing path by connecting the last defined path point to the start point. If the path is already closed, or if the path is only one point, this function is obsolete.

• ctx.moveTo
  (x, y)

  Move the current point to point (x,y) on the canvas.

• ctx.lineTo
  (x,y)

  Connects current point to point (x,y) on the canvas with a straight line.

• ctx.bezierCurveTo
  (cp1x, cp1y, cp2x, cp2y, x, y)

  Connects current point to point (x,y) using a bezier curve with the control points (cp1x,cp1y) and (cp2x,cp2y).

• ctx.quadraticeCurveTo
  (cp1x, cp1y, x, y)

  Connects current point to point (x,y) using a bezier curve with the control point (cp1x,cp1y).

• ctx.arc
  (x, y, r, angle1, angle2, antiClockWise)

  Create an arc with center (x,y), r as a radius, and angle1 and angle2 as the start and end angles respectively. AntiClockWise is an optional boolean to specify the direction of drawing the arc. Default is false.

• ctx.rect
  (x, y, w, h)

  creates a rectangular path starting at point (x,y) with width w and height h.

• ctx.fill()

  Fill the current path with current ctx.filltSyle.

• ctx.stroke()

  Strokes the current path(without filling) with current ctx.strokeStyle.

• ctx.setTransform
  (a, b, c, d, e, f)

  Sets current transformation matrix to the passed matrix. See MDN docs for more details.

• ctx.transform
  (a, b, c, d, e, f)

  Multiplies current transformation matrix with the passed matrix.See MDN docs for more details.

• ctx.rotate
  (angle)

  Adds rotation transformation from the point(0,0)(top left corner of the canvas) to the current transformation matrix.

• ctx.scale
  (x, y)

  Adds scaling transformation to the current transformation matrix.

• ctx.translate
  (x,y)

  Adds translation transformation to the current transformation.

• ctx.drawImage
  (img, sx, sy, swidth,
  sHeight, dx, dy,
  dWidth,
  dHeight)

  Draws an image with source img on the canvas. dx and dy specify the position to draw on the canvas starting from the top left corner.
  The rest of parameters are optional.dWidth and dHeight specify the area of the rectangle to draw on starting from point(dx,dy) on the canvas. sx and sy represent the coordinate offsets from the top left corner of the actual image. sWidth and sHeight specify the area of the image to draw. See MDN docs for more details.

• ctx.save
  ()

  Saves the current drawing state(set of properties) to be restored when needed. See MDN docs for more details.

• ctx.restore
  ()

  Restores the last saved drawing state. See MDN docs for more details.

Constructor

• path
  

  The image's path.

Properties

• onload =
  callback()

  Callback function for when the image is loaded.

Constructor

• video
  

  The video element that the texture is based on.

Properties

• format

  The texture format: HoloBuild.RGBAFormat (red, green, blue, and alpha).

Methods

• setTimeout
  (callback, time)

  use this method to call a function after a specific time (in miliseconds) has passed.