Class ViewInterface

Inheritance

object

Interface

ViewInterface

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Pixyz.View

Syntax

public class ViewInterface : Interface

Methods

AddAfterFramebufferCreateCallback(AfterFramebufferCreateDelegate, IntPtr)

Declaration

public uint AddAfterFramebufferCreateCallback(ViewInterface.AfterFramebufferCreateDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.AfterFramebufferCreateDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAfterViewerPropertyChangedCallback(AfterViewerPropertyChangedDelegate, IntPtr)

Declaration

public uint AddAfterViewerPropertyChangedCallback(ViewInterface.AfterViewerPropertyChangedDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.AfterViewerPropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAnimationPausedOrStoppedCallback(AnimationPausedOrStoppedDelegate, IntPtr)

Declaration

public uint AddAnimationPausedOrStoppedCallback(ViewInterface.AnimationPausedOrStoppedDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.AnimationPausedOrStoppedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAnimationPlayedOrResumedCallback(AnimationPlayedOrResumedDelegate, IntPtr)

Declaration

public uint AddAnimationPlayedOrResumedCallback(ViewInterface.AnimationPlayedOrResumedDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.AnimationPlayedOrResumedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAnimationPlayingStatusChangedCallback(AnimationPlayingStatusChangedDelegate, IntPtr)

Declaration

public uint AddAnimationPlayingStatusChangedCallback(ViewInterface.AnimationPlayingStatusChangedDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.AnimationPlayingStatusChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeFramebufferDeleteCallback(BeforeFramebufferDeleteDelegate, IntPtr)

Declaration

public uint AddBeforeFramebufferDeleteCallback(ViewInterface.BeforeFramebufferDeleteDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.BeforeFramebufferDeleteDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeViewerPropertyChangedCallback(BeforeViewerPropertyChangedDelegate, IntPtr)

Declaration

public uint AddBeforeViewerPropertyChangedCallback(ViewInterface.BeforeViewerPropertyChangedDelegate callback, IntPtr userData)

Parameters

Type	Name	Description
ViewInterface.BeforeViewerPropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddGPUScene(int, int)

Add a GPU scene to a viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddGPUScene(int scene, int viewer = -1)

Parameters

Type	Name	Description
int	scene	GPU Scene to render in the viewer
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

ApplyPlayingAnimations(ulong)

WARNING: this function is tagged as 'EXPERIMENTAL'
apply the animations

Declaration

[HandleProcessCorruptedStateExceptions]
public void ApplyPlayingAnimations(ulong time)

Parameters

Type	Name	Description
ulong	time	Current time

ConfigureFunctionLogger(string, bool, bool, bool)

Declaration

[HandleProcessCorruptedStateExceptions]
public void ConfigureFunctionLogger(string functionName, bool enableFunction, bool enableParameters, bool enableExecutionTime)

Parameters

Type	Name	Description
string	functionName
bool	enableFunction
bool	enableParameters
bool	enableExecutionTime

CreateGPUScene(OccurrenceList, bool)

Declaration

[HandleProcessCorruptedStateExceptions]
public int CreateGPUScene(OccurrenceList roots, bool constructEdges = false)

Parameters

Type	Name	Description
OccurrenceList	roots	Roots of the subtrees that will be uploaded to GPU
bool	constructEdges	Construct buffer to render edges colored by topology (slower to construct)

Returns

Type	Description
int

CreateStreamedViewer(int, int, EncoderSettings, bool, WebRTCInfo?)

create a viewer for streaming

Declaration

[HandleProcessCorruptedStateExceptions]
public StreamedViewerInfo CreateStreamedViewer(int width, int height, EncoderSettings encoderSettings = null, bool useWebRTC = false, WebRTCInfo? webRTCInfo = null)

Parameters

Type	Name	Description
int	width	Width of the viewer framebuffer
int	height	Height of the viewer framebuffer
EncoderSettings	encoderSettings	Settings used for the encoder
bool	useWebRTC	Switch between raw websockets and webRTC
WebRTCInfo?	webRTCInfo	Info for web rtc signaling connection

Returns

Type	Description
StreamedViewerInfo

CreateViewer(int, int, GraphicsContext, int)

Create a new viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public int CreateViewer(int width, int height, GraphicsContext sharedContext = null, int nbViews = 1)

Parameters

Type	Name	Description
int	width	Width of the viewer framebuffer
int	height	Height of the viewer framebuffer
GraphicsContext	sharedContext	Interop context handle
int	nbViews	Nb views

Returns

Type	Description
int

DestroyContext()

Destroy the Vulkan instance. All existing viewers and gpuScenes will also be destroyed and all view module properties will be reset

Declaration

[HandleProcessCorruptedStateExceptions]
public void DestroyContext()

DestroyGPUScene(int)

Declaration

[HandleProcessCorruptedStateExceptions]
public void DestroyGPUScene(int scene)

Parameters

Type	Name	Description
int	scene	GPU Scene to destroy (previously created by createGPUScene)

DestroyViewer(int)

Declaration

[HandleProcessCorruptedStateExceptions]
public void DestroyViewer(int viewer)

Parameters

Type	Name	Description
int	viewer	Viewer to destroy

DrawCappingPlane(uint)

Create an occurrence that holds the mesh of the surfaces that have been cut by the cutting plane

Declaration

[HandleProcessCorruptedStateExceptions]
public uint DrawCappingPlane(uint cuttingPlane)

Parameters

Type	Name	Description
uint	cuttingPlane	Cutting plane component for which we create the capping plane

Returns

Type	Description
uint

FitCamera(Point3, CameraType, double, int, OccurrenceList)

Set the viewer matrices to adjust the camera to the scene

Declaration

[HandleProcessCorruptedStateExceptions]
public void FitCamera(Point3 direction, CameraType cameraType = CameraType.Orthographic, double fov = 90, int viewer = -1, OccurrenceList fitToOccurrences = null)

Parameters

Type	Name	Description
Point3	direction	Camera direction
CameraType	cameraType	Camera type, Orthographic or Perspective
double	fov	Field of view (perspective mode only)
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
OccurrenceList	fitToOccurrences

GetAnimationPlayerInfo(uint)

WARNING: this function is tagged as 'EXPERIMENTAL'
packs all AnimationPlayer-related info about an animation in an object

Declaration

[HandleProcessCorruptedStateExceptions]
public AnimationPlayerInfo GetAnimationPlayerInfo(uint animation)

Parameters

Type	Name	Description
uint	animation	Animation to get info of

Returns

Type	Description
AnimationPlayerInfo

GetAutoClipping(int, Point3)

Automatically compute the near and far planes depending on the scene

Declaration

[HandleProcessCorruptedStateExceptions]
public Point2 GetAutoClipping(int viewer, Point3 cameraPos)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
Point3	cameraPos

Returns

Type	Description
Point2

GetCameraFrontAxis(int, uint)

Get the front axis of the nth view matrix of a given viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public Point3 GetCameraFrontAxis(int viewer = -1, uint matrixIndex = 0)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
uint	matrixIndex	Index of the view matrix to use.

Returns

Type	Description
Point3

GetCameraPosition(int, uint)

Get the position of the nth view matrix of a given viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public Point3 GetCameraPosition(int viewer = -1, uint matrixIndex = 0)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
uint	matrixIndex	Index of the view matrix to use.

Returns

Type	Description
Point3

GetCameraRightAxis(int, uint)

Get the right axis of the nth view matrix of a given viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public Point3 GetCameraRightAxis(int viewer = -1, uint matrixIndex = 0)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
uint	matrixIndex	Index of the view matrix to use.

Returns

Type	Description
Point3

GetCameraUpAxis(int, uint)

Get the up axis of the nth view matrix of a given viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public Point3 GetCameraUpAxis(int viewer = -1, uint matrixIndex = 0)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).
uint	matrixIndex	Index of the view matrix to use.

Returns

Type	Description
Point3

GetCompositedImage(int)

Declaration

[HandleProcessCorruptedStateExceptions]
public ImageDefinition GetCompositedImage(int viewer)

Parameters

Type	Name	Description
int	viewer

Returns

Type	Description
ImageDefinition

GetD3D11Texture(RenderMap, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public IntPtr GetD3D11Texture(RenderMap renderMap, int viewer = -1)

Parameters

Type	Name	Description
RenderMap	renderMap
int	viewer

Returns

Type	Description
IntPtr

GetGLTextureHandle(RenderMap, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public int GetGLTextureHandle(RenderMap renderMap, int viewer = -1)

Parameters

Type	Name	Description
RenderMap	renderMap
int	viewer

Returns

Type	Description
int

GetGlobalGPUScene()

Returns (and create if it does not exist) a global GPU scene (with the scene root) to be used commonly by several clients

Declaration

[HandleProcessCorruptedStateExceptions]
public int GetGlobalGPUScene()

Returns

Type	Description
int

GetLastAABB(int, int)

Return the lastAABB computed during a frame drawing, requires the viewer property ComputeLastAABB to be True

Declaration

[HandleProcessCorruptedStateExceptions]
public AABB GetLastAABB(int scene, int viewer)

Parameters

Type	Name	Description
int	scene	Identifier of the GPU scene to get the last AABB from
int	viewer

Returns

Type	Description
AABB

GetLastError()

Declaration

public static string GetLastError()

Returns

Type	Description
string

GetOccurrenceIndex(uint, int)

Returns the occurrence index in the viewer buffers. Can be used for mapping an index retrieved in a GLTextureHandle id map.

Declaration

[HandleProcessCorruptedStateExceptions]
public uint GetOccurrenceIndex(uint occurrence, int scene)

Parameters

Type	Name	Description
uint	occurrence	Occurrence identifier
int	scene	Scene identifier

Returns

Type	Description
uint

GetRenderMapImage(int, RenderMap)

Declaration

[HandleProcessCorruptedStateExceptions]
public ImageDefinition GetRenderMapImage(int viewer, RenderMap renderMap)

Parameters

Type	Name	Description
int	viewer
RenderMap	renderMap

Returns

Type	Description
ImageDefinition

GetSceneIndex(int, int)

Returns the GPU scene index in the viewer buffers. Can be used for mapping an index retrieved in a GLTextureHandle id map.

Declaration

[HandleProcessCorruptedStateExceptions]
public uint GetSceneIndex(int scene, int viewer)

Parameters

Type	Name	Description
int	scene	GPU scene identifier
int	viewer	Viewer identifier

Returns

Type	Description
uint

GetViewerMatrices(int)

Declaration

[HandleProcessCorruptedStateExceptions]
public GetViewerMatricesReturn GetViewerMatrices(int viewer = -1)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
GetViewerMatricesReturn

GetViewerProperty(string, int)

Get a viewer property value

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetViewerProperty(string propertyName, int viewer = -1)

Parameters

Type	Name	Description
string	propertyName
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
string

GetViewerPropertyInfo(string, int)

Get a viewer property info

Declaration

[HandleProcessCorruptedStateExceptions]
public PropertyInfo GetViewerPropertyInfo(string propertyName, int viewer = -1)

Parameters

Type	Name	Description
string	propertyName
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
PropertyInfo

GetViewerSize(int)

Retrieve the viewport size of a viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public GetViewerSizeReturn GetViewerSize(int viewer = -1)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
GetViewerSizeReturn

GetViewerStats(int)

Declaration

[HandleProcessCorruptedStateExceptions]
public GetViewerStatsReturn GetViewerStats(int viewer = -1)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
GetViewerStatsReturn

GetVulkanTexture(RenderMap, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public IntPtr GetVulkanTexture(RenderMap renderMap, int viewer = -1)

Parameters

Type	Name	Description
RenderMap	renderMap
int	viewer

Returns

Type	Description
IntPtr

IsAnimationPlaying(uint)

WARNING: this function is tagged as 'EXPERIMENTAL'
is this animation playing?

Declaration

[HandleProcessCorruptedStateExceptions]
public bool IsAnimationPlaying(uint animation)

Parameters

Type	Name	Description
uint	animation	Animation to check

Returns

Type	Description
bool

ListViewerProperties(int)

Get the list of viewer properties

Declaration

[HandleProcessCorruptedStateExceptions]
public PropertyInfoList ListViewerProperties(int viewer = -1)

Parameters

Type	Name	Description
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

Returns

Type	Description
PropertyInfoList

LockGPUSceneUpdate(int)

Lock the mutex that ensure no update of the gpu scene is done between lock/unlock

Declaration

[HandleProcessCorruptedStateExceptions]
public void LockGPUSceneUpdate(int scene)

Parameters

Type	Name	Description
int	scene	Identifier of the GPU scene to lock update for

LockGPUScenesUpdate(GPUSceneList)

Lock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock

Declaration

[HandleProcessCorruptedStateExceptions]
public void LockGPUScenesUpdate(GPUSceneList scenes)

Parameters

Type	Name	Description
GPUSceneList	scenes	Identifiers of the GPU scenes to lock update for

PauseAllAnimation()

WARNING: this function is tagged as 'EXPERIMENTAL'
pauses all animations

Declaration

[HandleProcessCorruptedStateExceptions]
public void PauseAllAnimation()

PauseAnimation(uint)

WARNING: this function is tagged as 'EXPERIMENTAL'
pauses an animation

Declaration

[HandleProcessCorruptedStateExceptions]
public void PauseAnimation(uint animation)

Parameters

Type	Name	Description
uint	animation	Animation to pause

Pick(int, int, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public PickReturn Pick(int x, int y, int viewer = -1)

Parameters

Type	Name	Description
int	x
int	y
int	viewer

Returns

Type	Description
PickReturn

PickRectangle(int, int, int, int, int, bool)

Declaration

[HandleProcessCorruptedStateExceptions]
public OccurrenceList PickRectangle(int xMin, int xMax, int yMin, int yMax, int viewer = -1, bool inDepth = false)

Parameters

Type	Name	Description
int	xMin
int	xMax
int	yMin
int	yMax
int	viewer
bool	inDepth

Returns

Type	Description
OccurrenceList

PlayAnimation(uint, double, bool)

WARNING: this function is tagged as 'EXPERIMENTAL'
plays an animation

Declaration

[HandleProcessCorruptedStateExceptions]
public void PlayAnimation(uint animation, double speed = 1, bool loop = false)

Parameters

Type	Name	Description
uint	animation	Animation to play
double	speed	Speed
bool	loop	Should the animation loop?

RefreshViewer(int)

Refresh the viewer

Declaration

[HandleProcessCorruptedStateExceptions]
public void RefreshViewer(int viewer = -1)

Parameters

Type	Name	Description
int	viewer	Viewer to refresh

RemoveAfterFramebufferCreateCallback(uint)

Declaration

public void RemoveAfterFramebufferCreateCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAfterViewerPropertyChangedCallback(uint)

Declaration

public void RemoveAfterViewerPropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAnimationPausedOrStoppedCallback(uint)

Declaration

public void RemoveAnimationPausedOrStoppedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAnimationPlayedOrResumedCallback(uint)

Declaration

public void RemoveAnimationPlayedOrResumedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAnimationPlayingStatusChangedCallback(uint)

Declaration

public void RemoveAnimationPlayingStatusChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeFramebufferDeleteCallback(uint)

Declaration

public void RemoveBeforeFramebufferDeleteCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeViewerPropertyChangedCallback(uint)

Declaration

public void RemoveBeforeViewerPropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveGPUScene(int, int)

Remove a viewer root

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveGPUScene(int scene, int viewer = -1)

Parameters

Type	Name	Description
int	scene	GPU Scene to remove from the viewer
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

ResizeStreamedViewer(int, int, int, EncoderSettings)

Declaration

[HandleProcessCorruptedStateExceptions]
public void ResizeStreamedViewer(int width, int height, int viewer = -1, EncoderSettings encoderSettings = null)

Parameters

Type	Name	Description
int	width	Width of the viewer framebuffer
int	height	Height of the viewer framebuffer
int	viewer
EncoderSettings	encoderSettings	Settings used for the encoder

ResizeViewer(int, int, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public void ResizeViewer(int width, int height, int viewer = -1)

Parameters

Type	Name	Description
int	width	Width of the viewer framebuffer
int	height	Height of the viewer framebuffer
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

ResumeAllAnimation()

WARNING: this function is tagged as 'EXPERIMENTAL'
resumes all animations

Declaration

[HandleProcessCorruptedStateExceptions]
public void ResumeAllAnimation()

ResumeAnimation(uint)

WARNING: this function is tagged as 'EXPERIMENTAL'
resumes an animation

Declaration

[HandleProcessCorruptedStateExceptions]
public void ResumeAnimation(uint animation)

Parameters

Type	Name	Description
uint	animation	Animation to resume

SelectPrimitives(int, int, int, int, PrimitiveSelectionType, int)

Select the primitives (polygons, surfaces) contained in the given rectangle

Declaration

[HandleProcessCorruptedStateExceptions]
public void SelectPrimitives(int xMin, int xMax, int yMin, int yMax, PrimitiveSelectionType primitiveType, int viewer = -1)

Parameters

Type	Name	Description
int	xMin
int	xMax
int	yMin
int	yMax
PrimitiveSelectionType	primitiveType
int	viewer

SetAnimationFrame(uint, ulong)

WARNING: this function is tagged as 'EXPERIMENTAL'
set animation's current frame

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetAnimationFrame(uint animation, ulong frame)

Parameters

Type	Name	Description
uint	animation	Animation to set frame
ulong	frame	Frame to set

SetAnimationLoop(uint, bool)

WARNING: this function is tagged as 'EXPERIMENTAL'
set animation's looping status

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetAnimationLoop(uint animation, bool loop)

Parameters

Type	Name	Description
uint	animation	Animation to set loop status
bool	loop	Should the animation loop?

SetAnimationSpeed(uint, double)

WARNING: this function is tagged as 'EXPERIMENTAL'
set animation's playing speed

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetAnimationSpeed(uint animation, double speed)

Parameters

Type	Name	Description
uint	animation	Animation to set speed
double	speed	The speed

SetDefaultViewerId(int)

Set default viewer id. This viewer will be used in other functions taking a Viewer as a parameter. Useful if a viewer needs to be shared across different contexts.

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetDefaultViewerId(int viewer)

Parameters

Type	Name	Description
int	viewer

SetViewerMatrices(Matrix4List, Matrix4List, Point2, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetViewerMatrices(Matrix4List views, Matrix4List projs, Point2 clipping, int viewer = -1)

Parameters

Type	Name	Description
Matrix4List	views
Matrix4List	projs
Point2	clipping
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

SetViewerProperty(string, string, int)

Set a viewer property value

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetViewerProperty(string propertyName, string propertyValue, int viewer = -1)

Parameters

Type	Name	Description
string	propertyName
string	propertyValue
int	viewer	Viewer id returned by the createViewer function. -1 uses the default viewer id (see setDefaultViewerId).

StartRecording(string, int, EncoderSettings)

record viewer in a file

Declaration

[HandleProcessCorruptedStateExceptions]
public void StartRecording(string filePath, int viewer, EncoderSettings encoderSettings = null)

Parameters

Type	Name	Description
string	filePath	File in which video while be saved
int	viewer	Viewer to use for recording video
EncoderSettings	encoderSettings	Settings used for the encoder

StopAllAnimation(bool)

WARNING: this function is tagged as 'EXPERIMENTAL'
stops all animations

Declaration

[HandleProcessCorruptedStateExceptions]
public void StopAllAnimation(bool applyDefault = true)

Parameters

Type	Name	Description
bool	applyDefault	Should the default position be applied

StopAnimation(uint, bool)

WARNING: this function is tagged as 'EXPERIMENTAL'
stops an animation

Declaration

[HandleProcessCorruptedStateExceptions]
public void StopAnimation(uint animation, bool applyDefault = true)

Parameters

Type	Name	Description
uint	animation	Animation to stop
bool	applyDefault	Should the default position be applied

StopRecording(int)

stop recording video

Declaration

[HandleProcessCorruptedStateExceptions]
public void StopRecording(int viewer)

Parameters

Type	Name	Description
int	viewer	Viewer to use for recording video

SuitableGPUAvailable()

returns true if a suitable device is found.

Declaration

[HandleProcessCorruptedStateExceptions]
public bool SuitableGPUAvailable()

Returns

Type	Description
bool

TakeScreenshot(string, int)

Declaration

[HandleProcessCorruptedStateExceptions]
public void TakeScreenshot(string fileName, int viewer)

Parameters

Type	Name	Description
string	fileName	Path where to save the screenshot
int	viewer

TryLockGPUSceneUpdate(int)

Try to lock the mutex that ensure no update of the gpu scene is done between lock/unlock, returns true if the mutex has been locked, false if it was already locked

Declaration

[HandleProcessCorruptedStateExceptions]
public bool TryLockGPUSceneUpdate(int scene)

Parameters

Type	Name	Description
int	scene	Identifier of the GPU scene to try to lock update for

Returns

Type	Description
bool

TryLockGPUScenesUpdate(GPUSceneList)

Try to lock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock, returns true if the mutex has been locked, false if it was already locked

Declaration

[HandleProcessCorruptedStateExceptions]
public BoolList TryLockGPUScenesUpdate(GPUSceneList scenes)

Parameters

Type	Name	Description
GPUSceneList	scenes	Identifiers of the GPU scenes to try to lock update for

Returns

Type	Description
BoolList

UnlockGPUSceneUpdate(int)

Unlock the mutex that ensure no update of the gpu scene is done between lock/unlock

Declaration

[HandleProcessCorruptedStateExceptions]
public void UnlockGPUSceneUpdate(int scene)

Parameters

Type	Name	Description
int	scene	Identifier of the GPU scene to unlock update for

UnlockGPUScenesUpdate(GPUSceneList)

Unlock the mutex that ensure no update of multiple gpu scenes is done between lock/unlock

Declaration

[HandleProcessCorruptedStateExceptions]
public void UnlockGPUScenesUpdate(GPUSceneList scenes)

Parameters

Type	Name	Description
GPUSceneList	scenes	Identifiers of the GPU scenes to unlock update for

VisibilityShoot(int, bool, bool, bool, bool)

Render one frame of the visibility session

Declaration

[HandleProcessCorruptedStateExceptions]
public OccurrenceList VisibilityShoot(int viewer = -1, bool parts = true, bool patches = true, bool polygons = true, bool countOnce = false)

Parameters

Type	Name	Description
int	viewer	Viewer to use for the visibility shoot
bool	parts	If false, optimize when parts seen are not wanted
bool	patches	If false, optimize when patches seen are not wanted
bool	polygons	If false, optimize when polygons seen are not wanted
bool	countOnce	Optimize when it is not needed to count the numbers of pixels seen during the session

Returns

Type	Description
OccurrenceList