Class GaussianSplatSpaceComponent

Inheritance Relationships

Base Types

Class Documentation

class GaussianSplatSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IExternalResourceComponent, public csp::multiplayer::IShadowCasterComponent, public csp::multiplayer::ITransformComponent, public csp::multiplayer::IVisibleComponent

Add Gaussian Splats to your space.

Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple points of view. Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a volume, comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3 axis).

Public Functions

GaussianSplatSpaceComponent(SpaceEntity *Parent)

Constructs the Gaussian Splat component, and associates it with the specified Parent space entity.

Parameters

Parent – The Space entity that owns this component.

virtual const csp::common::String &GetExternalResourceAssetId() const override

Gets the ID of the asset associated with this component.

Note

To retrieve this component’s gaussian splat asset, both the Asset ID and the Asset Collection ID are required.

Returns

The ID of the asset associated with this component.

virtual void SetExternalResourceAssetId(const csp::common::String &Value) override

Sets the ID of the asset associated with this component.

Note

To retrieve this component’s gaussian splat asset, both the Asset ID and the Asset Collection ID are required.

Parameters

Value – The ID of the asset associated with this component.

virtual const csp::common::String &GetExternalResourceAssetCollectionId() const override

Gets the ID of the asset collection associated with this component.

Note

To retrieve this component’s gaussian splat asset, both the Asset ID and the Asset Collection ID are required.

Returns

The ID of the asset collection associated with this component.

virtual void SetExternalResourceAssetCollectionId(const csp::common::String &Value) override

Sets the ID of the asset collection associated with this component.

Note

To retrieve this component’s gaussian splat asset, both the Asset ID and the Asset Collection ID are required.

Parameters

Value – The ID of the asset collection associated with this component.

const csp::common::Vector3 &GetTint() const

Gets the tint that should be globally applied to the Gaussian Splat associated with this component.

Returns

The global tint value, expected to be in RGB color space, with each value normalised between 0…1.

void SetTint(const csp::common::Vector3 &TintValue)

Sets the tint that should be globally applied to the Gaussian Splat.

Parameters

Value – The tint value, expected to be in RGB color space, with each value normalised between 0…1. Defaults to 1,1,1.