FI3DHConnectOptions Struct Reference

FI3DHConnectOptions Struct Reference#

instant3Dhub: FI3DHConnectOptions Struct Reference

instant3Dhub

#include "I3DHConnector.h"

Collaboration diagram for FI3DHConnectOptions:

Detailed Description

Contains optional parameters for connecting to the hub.

See also: AI3DHConnector::ConnectToHubWithOptions()

Public Attributes
FString	SessionId
FString	SpaceId
FString	RoleKey
bool	bCloneIntoNewSpace = false
FString	RestoreSessionId

Member Data Documentation

◆ bCloneIntoNewSpace

bool FI3DHConnectOptions::bCloneIntoNewSpace = false

If set, immediately clones the 3D space specified by SpaceId into a new space after opening it.

The new id can be queried with AI3DHConnector::GetSpaceId() after the connection has been established.

Only valid in combination with SpaceId.

Only supported on instant3Dhub 3.12+.

◆ RestoreSessionId

FString FI3DHConnectOptions::RestoreSessionId

Identifier of a stored session.

If set, SpaceId must be empty. In this case the newly opened 3D space will be initialized with the stored session.

Must include the "urn:X-i3d:session:" prefix.

Incompatible with SpaceId.

◆ RoleKey

FString FI3DHConnectOptions::RoleKey

If set, requests a specific member role when opening the 3D space.

Only valid in combination with SpaceId.

Only supported on instant3Dhub 3.12+.

◆ SessionId

FString FI3DHConnectOptions::SessionId

If set, connect to the specified session.

If empty, a new empty session will be created and the id can be queried with AI3DHConnector::GetSessionId() after the connection has been established.

Incompatible with RestoreSessionId.

◆ SpaceId

FString FI3DHConnectOptions::SpaceId

If set, opens the specified 3D space.

If empty, a new empty 3D space will be created and the id can be queried with AI3DHConnector::GetSpaceId() after the connection has been established.