stingray.Hololens namespace reference

Description

This object provides access to the Hololens interface.

Other related reference items

Plug-ins

Functions

attach_entity ( entity, world, anchor_id, position, rotation ) : boolean Attaches an entity with a transform component to an anchor

Parameters

entity :	stingray.Entity	The entity to attach
world :	stingray.World	The world containing the entity
anchor_id :	integer	Id of the anchor to attach to
position :	stingray.Vector3?	Optional position offset relative to the anchor The ? notation indicates that this type is optional: there may be zero or one instances of it.
rotation :	stingray.Quaternion?	Optional rotation offset relative to the anchor The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

boolean

True if the entity was attached

The transform component will be updated to keep the entity from drifting in space.

create_anchor ( position, rotation ) : integer Create a Spatial Anchor at position.

Parameters

position :	stingray.Vector3	Position of anchor
rotation :	stingray.Quaternion?	Optional rotation of anchor The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

Anchor Id

Returns a anchor_id used to track the anchor.

Use Hololens.destroy_anchor() to destroy the anchor when it's no longer in use.

destroy_anchor ( anchor_id ) Frees up the resources used by the anchor with supplied id.

Parameters

anchor_id :

integer

Id of the Spatial Anchor to destroy

Returns

This function does not return any values.

Other related reference items

stingray.Hololens.create_anchor()

detach_entity ( entity, anchor_id ) Detaches an entity from a Spatial Anchor, stopping the transform component from being updated.

Parameters

entity :	stingray.Entity	The entity to detach
anchor_id :	integer	Id of the anchor to detach from

Returns

This function does not return any values.

head_pose ( ) : stingray.Matrix4x4 Returns the head pose

Parameters

This function does not accept any parameters.

Returns

stingray.Matrix4x4

Head pose

initialize ( render_target, camera, world ) : boolean Initializes Hololens system.

Parameters

render_target :	string	The stereo render target name.
camera :	stingray.Camera	The camera used for stereo rendering.
world :	stingray.World	The world containing the camera.

Returns

boolean

Returns true if Hololens was initialized properly, otherwise returns false.

interaction_held ( interaction ) : boolean Whether an interaction (hand/controller) is held.

Parameters

interaction :

number

Interaction Type [Hololens.HAND, Hololens.CONTROLLER]

Returns

boolean

true if a press has been continued over from a previous frame, or false otherwise.

interaction_pressed ( interaction ) : boolean Whether an interaction (hand/controller) has detected a press event.

Parameters

interaction :

number

Interaction Type [Hololens.HAND, Hololens.CONTROLLER]

Returns

boolean

true if a press event has been detected since the last frame, or false otherwise.

interaction_released ( interaction ) : boolean Whether an interaction (hand/controller) has detected a release event.

Parameters

interaction :

number

Interaction Type [Hololens.HAND, Hololens.CONTROLLER]

Returns

boolean

true if a release event has been detected since the last frame, or false otherwise.

set_focus_point ( point ) Informs the system about a specific point in your scene to prioritize for image stabilization.

Parameters

point :

stingray.Vector3

The world-space coordinate to set the stabilization plane to.

Returns

This function does not return any values.

spatial_map_setup ( entity, material, world ) Specify the environment map unit to be filled with surface geometry meshes.

Parameters

entity :	stingray.Entity	Empty entity which will have mesh components for each surface detected by the Hololens
material :	string	Name of material
world :	stingray.World	World containing the entity

Returns

This function does not return any values.