Class ImageSpaceComponent

Defined in File ImageSpaceComponent.h

Inheritance Relationships

Base Types

public csp::multiplayer::ComponentBase (Class ComponentBase)
public csp::multiplayer::ITransformComponent (Class ITransformComponent)
public csp::multiplayer::IVisibleComponent (Class IVisibleComponent)

Class Documentation

class ImageSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::ITransformComponent, public csp::multiplayer::IVisibleComponent 

Add an image to your space.

Public Functions

ImageSpaceComponent(SpaceEntity *Parent)

Constructs the image space 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

Gets the name of this image space component.

Returns: The name of this image space component.

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

Sets the name of this image space component.

Parameters: Value – The name of this image space component.

const csp::common::String &GetImageAssetId() const

Gets the ID of the image asset this image component refers to.

Returns: The ID of the image asset this image component refers to.

void SetImageAssetId(const csp::common::String &Value)

Sets the ID of the image asset this image component refers to.

Parameters: Value – The ID of the image asset this image component refers to.

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

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

Note

To retrieve this component’s image 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 image asset, both the Asset ID and the Asset Collection ID are required.

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

BillboardMode GetBillboardMode() const

Gets the billboard mode used by this image component.

Returns: The billboard mode used by this image component.

void SetBillboardMode(BillboardMode billboardMode)

Sets the billboard mode used by this image component.

Parameters: billboardMode – The billboard mode used by this image component.

DisplayMode GetDisplayMode() const

Gets the display mode used by this image component.

Returns: The display mode used by this image component.

void SetDisplayMode(DisplayMode displayMode)

Sets the display mode used by this image component.

Parameters: displayMode – The display mode used by this image component.

bool GetIsEmissive() const

Checks if the image of this image component is emissive.

Returns: True if the image of this image component is emissive, false otherwise.

void SetIsEmissive(bool InValue)

Sets if the image of this image component is emissive.

Parameters: InValue – True if the image of this image component is emissive, false otherwise.