RenderingConnection Class

Definition

Main entry point for Remote Rendering specific actions. Can be accessed via RenderingSession.Connection, after a successful connection.

public ref class RenderingConnection
public class RenderingConnection
type RenderingConnection = class
Public Class RenderingConnection
Inheritance
RenderingConnection

Properties

CameraSettings

Global camera settings.

DebugRenderingSettings

Global debug rendering settings.

LogLevel

Only messages at this log level or below will be delivered through MessageLogged.

OutlineSettings

Global outline settings.

PointCloudSettings_Experimental

Experimental: Access the global point cloud settings.

RootEntities

Retrieves the list of all root entities. A root entity is any existing entity that has no Parent. This includes root entities created through loading a model and entities created client-side. The returned entities do not appear in a specific order in the list.

ShellRenderingSettings

Global shell rendering settings.

SingleSidedSettings

Global single-sided rendering settings.

SkyReflectionSettings

Global sky reflection settings.

StageSpaceSettings

Global stage space settings.

ZFightingMitigationSettings

Global z-fighting mitigation state.

Methods

CreateComponent(ObjectType, Entity)

Creates a new component.

CreateEntity()

Creates a new entity.

CreateMaterial(MaterialType)

Creates a new Material.

GetRootEntities(List<Entity>)
LoadModelAsync(LoadModelOptions, Action<Single>)

Initiates the loading of a model which is located in Azure storage.

LoadModelFromSasAsync(LoadModelFromSasOptions, Action<Single>)

Initiates the loading of a model using a SAS token to identify the model.

LoadTextureAsync(LoadTextureOptions)

Initiates the loading of a texture which is located in Azure storage.

LoadTextureFromSasAsync(LoadTextureFromSasOptions)

Initiates the loading of a texture using a SAS token to identify the texture.

QueryServerPerformanceAssessmentAsync()

Performs a performance assessment query on the server.

RayCastQueryAsync(RayCast)

Performs a raycast query on the remote scene.

SpatialQueryAabbAsync(SpatialQueryAabb)

Performs a spatial query on the remote scene using an axis-aligned bounding box (AABB) as the query volume.

SpatialQueryAsync(SpatialQuery)

Performs a spatial query on the remote scene.

SpatialQueryObbAsync(SpatialQueryObb)

Performs a spatial query on the remote scene using an oriented box as the query volume.

SpatialQuerySphereAsync(SpatialQuerySphere)

Performs a spatial query on the remote scene using a sphere as the query volume.

Update()

Pushes all client updates to the server and dispatches all messages received from the server.

Events

MessageLogged

Log messages are delivered through this callback.

Updated

Event that is called after Update() has finished.

Applies to

See also