Snapshot API

instant3Dhub

Classes | Functions

Snapshot API

instant3Dhub Interfaces

Detailed Description

Snapshots are a subset of a 3D Space and describe a momentary state, which includes the state of the InstanceGraph and other elements of the 3D Space like ClipPlanes.

Note

In WebVis the snapshot functionality is part of the SessionStorageAPI.

Classes
class	FI3DHSnapshotAPI

Functions
virtual void	FI3DHSnapshotAPI::GetSnapshots (TUniqueFunction< void(TArray< FI3DHSnapshotDescriptor > Snapshots, EI3DHErrorCode ErrorCode)> OnComplete)=0
virtual void	FI3DHSnapshotAPI::RestoreSnapshot (int SnapshotId, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

Function Documentation

◆ GetSnapshots()

virtual void FI3DHSnapshotAPI::GetSnapshots ( TUniqueFunction< void(TArray< FI3DHSnapshotDescriptor > Snapshots, EI3DHErrorCode ErrorCode)> OnComplete )

pure virtual

Gets a list of snapshot descriptors.

Parameters

OnComplete

Callback called on completion: OnComplete(EI3DHErrorCode::Success) if successful. OnComplete(EI3DHErrorCode) on error.

◆ RestoreSnapshot()

virtual void FI3DHSnapshotAPI::RestoreSnapshot ( int SnapshotId, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete )

pure virtual

Restore snapshot matching a SnapshotId.

Parameters

SnapshotId	The id of the snapshot to be restored (see FI3DHSnapshotDescriptor::Id)
OnComplete	Callback called on completion: OnComplete(EI3DHErrorCode::Success) if successful. OnComplete(EI3DHErrorCode) on error.

---

Generated by  1.12.0