Class FiducialMarkerSpaceComponent

• Defined in File FiducialMarkerSpaceComponent.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 FiducialMarkerSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::ITransformComponent, public csp::multiplayer::IVisibleComponent

As an alternative to cloud-based anchors, fiducial markers can be used to anchor your space to a physical location.

Public Functions

FiducialMarkerSpaceComponent(csp::common::LogSystem *LogSystem, SpaceEntity *Parent)

Constructs the fiducial marker 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 fiducial marker space component.

Returns

The name of this fiducial marker space component.

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

Sets the name of this fiducial marker space component.

Parameters

Value – The name of this fiducial marker space component.

const csp::common::String &GetMarkerAssetId() 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 SetMarkerAssetId(const csp::common::String &Value)

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

Parameters

Value – The ID of the image asset this fiducial marker 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.

Public Static Functions

static const ComponentSchema &GetSchema()

static std::unique_ptr<FiducialMarkerSpaceComponent> TryMake(const ComponentSchema &InSchema, csp::common::LogSystem *LogSystem, SpaceEntity *Parent)

Creates a fiducial marker space component using the provided schema if it is compatible with the built-in schema.

See also

csp::multiplayer::IsCompatible

Parameters

• InSchema – The schema to use. Must be compatible with the built-in schema.

• LogSystem – The log system.

• Parent – The space entity that owns this component.

Returns

A new FiducialMarkerSpaceComponent if the schema is compatible, nullptr otherwise.