You are here: Start » Function Reference » Gocator » Gocator_GrabPoint3DGrid_WithTimeout

Gocator_GrabPoint3DGrid_WithTimeout

Header:	ThirdPartySdk.h
Namespace:	fil

Captures Point3DGrid (Un-Resampled surface) from Gocator device with timeout; returns Nil if no data comes in the specified time.

Syntax

bool fil::Gocator_GrabPoint3DGrid_WithTimeout
(
	Gocator_State& ioState,
	const ftl::Optional<fil::GocatorAddress>& inAddress,
	int inInputQueueSize,
	int inTimeout,
	ftl::Conditional<fil::Point3DGrid>& outPoint3DGrid,
	ftl::Conditional<fil::Image>& outSurfaceIntensity,
	ftl::Conditional<fil::GocatorFrameInfo>& outFrameInfo
)

Parameters

Name	Type	Range	Default	Description
ioState	Gocator_State&			Object used to maintain state of the function.
inAddress	const Optional<GocatorAddress>&		NIL	Gocator Device identifying IP address (e.g. "127.0.0.1") or serial number (e.g. "SN:17335")
inInputQueueSize	int	1 - 200		Number of incoming frames that can be buffered before the application is able to process them
inTimeout	int	10 -	100	Maximum time to wait for data in milliseconds
outPoint3DGrid	Conditional<Point3DGrid>&
outSurfaceIntensity	Conditional<Image>&
outFrameInfo	Conditional<GocatorFrameInfo>&

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.