HoloToolkit.Unity.SpatialUnderstandingDllTopology Class Reference

Encapsulates the topology queries of the understanding DLL. These queries will not be valid until after scanning is finalized. More...

Classes
struct	TopologyResult
	Result of a topology query. Typically results return an array of these structures. More...

Public Member Functions
static int	QueryTopology_FindPositionsOnWalls ([In] float minHeightOfWallSpace, [In] float minWidthOfWallSpace, [In] float minHeightAboveFloor, [In] float minFacingClearance, [In] int locationCount, [In, Out] IntPtr locationData)
	Finds spaces on walls meeting the criteria specified by the parameters. More...
static int	QueryTopology_FindLargePositionsOnWalls ([In] float minHeightOfWallSpace, [In] float minWidthOfWallSpace, [In] float minHeightAboveFloor, [In] float minFacingClearance, [In] int locationCount, [In, Out] IntPtr locationData)
	Finds only large spaces on walls meeting the criteria specified by the parameters. More...
static int	QueryTopology_FindLargestWall ([In, Out] IntPtr wall)
	Finds the largest wall More...
static int	QueryTopology_FindPositionsOnFloor ([In] float minLengthOfFloorSpace, [In] float minWidthOfFloorSpace, [In] int locationCount, [In, Out] IntPtr locationData)
	Finds spaces on the floor meeting the criteria specified by the parameters. More...
static int	QueryTopology_FindLargestPositionsOnFloor ([In] int locationCount, [In, Out] IntPtr locationData)
	Finds the largest spaces on the floor More...
static int	QueryTopology_FindPositionsSittable ([In] float minHeight, [In] float maxHeight, [In] float minFacingClearance, [In] int locationCount, [In, Out] IntPtr locationData)
	Finds good spaces for sitting or placing objects on surfaces. More...
static int	QueryTopology_FindLargePositionsSittable ([In] float minHeight, [In] float maxHeight, [In] float minFacingClearance, [In] float minWidth, [In] int locationCount, [In, Out] IntPtr locationData)
	Finds only large spaces on platforms meeting the criteria specified by the parameters. More...

Detailed Description

Encapsulates the topology queries of the understanding DLL. These queries will not be valid until after scanning is finalized.

Definition at line 16 of file SpatialUnderstandingDllTopology.cs.

Member Function Documentation

QueryTopology_FindLargePositionsOnWalls()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindLargePositionsOnWalls	(	[In] float	minHeightOfWallSpace,
		[In] float	minWidthOfWallSpace,
		[In] float	minHeightAboveFloor,
		[In] float	minFacingClearance,
		[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds only large spaces on walls meeting the criteria specified by the parameters.

Parameters

minHeightOfWallSpace	Minimum height of space to be found by the query
minWidthOfWallSpace	Minimum width of space to be found by the query
minHeightAboveFloor	Minimum distance above the floor for the bottom edge of the space
minFacingClearance	Minimum amount of space in front of the space
locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

QueryTopology_FindLargePositionsSittable()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindLargePositionsSittable	(	[In] float	minHeight,
		[In] float	maxHeight,
		[In] float	minFacingClearance,
		[In] float	minWidth,
		[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds only large spaces on platforms meeting the criteria specified by the parameters.

Parameters

minHeight	Minimum height above the floor for a space
maxHeight	Maximum height above the floor for a space
minFacingClearance	Minimum clearance for the space above the placement surface (minimum space height)
minWidth	Minimum required width on placement surface
locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

QueryTopology_FindLargestPositionsOnFloor()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindLargestPositionsOnFloor	(	[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds the largest spaces on the floor

Parameters

locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

QueryTopology_FindLargestWall()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindLargestWall

(

[In, Out] IntPtr

wall

)

Finds the largest wall

Parameters

wall	Pointer to a TopologyResult structure, to be filled with the found wall

Returns

Zero if fails, one if success

QueryTopology_FindPositionsOnFloor()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindPositionsOnFloor	(	[In] float	minLengthOfFloorSpace,
		[In] float	minWidthOfFloorSpace,
		[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds spaces on the floor meeting the criteria specified by the parameters.

Parameters

minLengthOfFloorSpace	Minimum length of space to be found by the query
minWidthOfFloorSpace	Minimum width of space to be found by the query
locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

QueryTopology_FindPositionsOnWalls()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindPositionsOnWalls	(	[In] float	minHeightOfWallSpace,
		[In] float	minWidthOfWallSpace,
		[In] float	minHeightAboveFloor,
		[In] float	minFacingClearance,
		[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds spaces on walls meeting the criteria specified by the parameters.

Parameters

minHeightOfWallSpace	Minimum height of space to be found by the query
minWidthOfWallSpace	Minimum width of space to be found by the query
minHeightAboveFloor	Minimum distance above the floor for the bottom edge of the space
minFacingClearance	Minimum amount of space in front of the space
locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

QueryTopology_FindPositionsSittable()

static int HoloToolkit.Unity.SpatialUnderstandingDllTopology.QueryTopology_FindPositionsSittable	(	[In] float	minHeight,
		[In] float	maxHeight,
		[In] float	minFacingClearance,
		[In] int	locationCount,
		[In, Out] IntPtr	locationData
	)

Finds good spaces for sitting or placing objects on surfaces.

Parameters

minHeight	Minimum height above the floor for a space
maxHeight	Maximum height above the floor for a space
minFacingClearance	Minimum clearance for the space above the placement surface (minimum space height)
locationCount	Number of location results supplied by the user in locationData
locationData	Location result array of TopologyResult to be filled with the spaces found by the query

Returns

Number of spaces found by the query. This value is limited by the number of results supplied by the caller (locationCount)

---

The documentation for this class was generated from the following file:

• Assets/HoloToolkit/SpatialUnderstanding/Scripts/SpatialUnderstandingDllTopology.cs