Class ReflectionSpaceComponent

Inheritance Relationships

Base Types

Class Documentation

class ReflectionSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IPositionComponent, public csp::multiplayer::IScaleComponent, public csp::multiplayer::IThirdPartyComponentRef

Add sphere and box reflection captures to your Space which can be used by objects with reflective materials.

Public Functions

ReflectionSpaceComponent(SpaceEntity *Parent)

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

Parameters

Parent – The Space entity that owns this component.

const csp::common::String &GetName() const

Get the name of the Reflection component.

Returns

csp::common::String specifying the component name.

void SetName(const csp::common::String &Value)

Set the name for the Reflection component.

Parameters

Value – const csp::common::String& : Name for the Reflection component.

const csp::common::String &GetReflectionAssetId() const

Get the Asset Id for the Reflection texture asset.

void SetReflectionAssetId(const csp::common::String &Value)

Set the Asset Id for the Reflection texture asset.

Parameters

Value – const csp::common::String& : Id for Reflection texture asset.

const csp::common::String &GetAssetCollectionId() const

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

Note

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

Returns

The ID of the asset collection associated with this component.

void SetAssetCollectionId(const csp::common::String &Value)

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

Note

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

Parameters

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

ReflectionShape GetReflectionShape() const

Get the reflection shape enum value.

ReflectionShape.UnitBox: Projects a texture in a planar fashion from all six directions (like an inward facing cube). ReflectionShape.UnitSphere: Warps the texture into a spherical shape and projects it onto a surface.

Returns

Enum specifying whether the captured reflections are box projected (UnitCube) or spherical projected (UnitSphere).

void SetReflectionShape(ReflectionShape Value)

Set the reflection shape.

ReflectionShape.UnitBox: Projects a texture in a planar fashion from all six directions (like an inward facing cube). ReflectionShape.UnitSphere: Warps the texture into a spherical shape and projects it onto a surface.

Parameters

Value – ReflectionShape : Enum specifying whether the captured reflections are box (UnitCube) or spherical projected (UnitSphere).