EntityViewer - Vircadia API Docs

Description

Supported Script Types: Assignment Client Scripts

The EntityViewer API provides a headless viewer for assignment client scripts, so that they can "see" entities in order for them to be available in the Entities API.

Methods

Name	Return Value	Summary
`getBoundaryLevelAdjust`	number	Deprecated: This function is deprecated and will be removed.
`getMaxPacketsPerSecond`	number	Gets the maximum number of entity packets to receive from the domain server per second.
`getOctreeElementsCount`	number	Gets the number of nodes in the octree.
`getOrientation`	Quat	Gets the orientation of the view frustum.
`getPosition`	Vec3	Gets the position of the view frustum.
`getVoxelSizeScale`	number	Deprecated: This function is deprecated and will be removed.
`queryOctree`	None	Updates the entities currently in view.
`setBoundaryLevelAdjust`	None	Deprecated: This function is deprecated and will be removed.
`setCenterRadius`	None	Sets the radius of the center "keyhole" in the view frustum.
`setKeyholeRadius`	None	Sets the radius of the center "keyhole" in the view frustum. Deprecated: This function is deprecated and will be removed. Use setCenterRadius instead.
`setMaxPacketsPerSecond`	None	Sets the maximum number of entity packets to receive from the domain server per second.
`setOrientation`	None	Sets the orientation of the view frustum.
`setPosition`	None	Sets the position of the view frustum.
`setVoxelSizeScale`	None	Deprecated: This function is deprecated and will be removed.

Method Details

(static) getBoundaryLevelAdjust( ) → {number} Returns: The boundary level adjust factor.
Deprecated: This function is deprecated and will be removed.

(static) getMaxPacketsPerSecond( ) → {number} Returns: The maximum number of entity packets to receive per second.
Gets the maximum number of entity packets to receive from the domain server per second.

(static) getOctreeElementsCount( ) → {number} Returns: The number of nodes in the octree.
Gets the number of nodes in the octree.

(static) getOrientation( ) → {Quat} Returns: The orientation of the view frustum.
Gets the orientation of the view frustum.

(static) getPosition( ) → {Vec3} Returns: The position of the view frustum.
Gets the position of the view frustum.

(static) getVoxelSizeScale( ) → {number} Returns: The voxel size scale.
Deprecated: This function is deprecated and will be removed.

(static) queryOctree( )
Updates the entities currently in view.

(static) setBoundaryLevelAdjust( boundaryLevelAdjust )

Deprecated: This function is deprecated and will be removed.

Parameters

Name	Type	Description
`boundaryLevelAdjust`	number	The boundary level adjust factor.

(static) setCenterRadius( radius )

Sets the radius of the center "keyhole" in the view frustum.

Parameters

Name	Type	Description
`radius`	number	The radius of the center "keyhole" in the view frustum.

(static) setKeyholeRadius( radius )

Sets the radius of the center "keyhole" in the view frustum.

Deprecated: This function is deprecated and will be removed. Use setCenterRadius instead.

Parameters

Name	Type	Description
`radius`	number	The radius of the center "keyhole" in the view frustum.

(static) setMaxPacketsPerSecond( maxPacketsPerSecond )

Sets the maximum number of entity packets to receive from the domain server per second.

Parameters

Name	Type	Description
`maxPacketsPerSecond`	number	The maximum number of entity packets to receive per second.

(static) setOrientation( orientation )

Sets the orientation of the view frustum.

Parameters

Name	Type	Description
`orientation`	Quat	The orientation of the view frustum.

(static) setPosition( position )

Sets the position of the view frustum.

Parameters

Name	Type	Description
`position`	Vec3	The position of the view frustum.

(static) setVoxelSizeScale( sizeScale )

Deprecated: This function is deprecated and will be removed.

Parameters

Name	Type	Description
`sizeScale`	number	The voxel size scale.