Class LandmarkDefinition

Defines an identifiable piece of an object. The definition includes a name, the acceptable output type (types that inherit from ILandmarkOutput) and an option settings type (type that inherits from ILandmarkSettings).

Inheritance

Object

LandmarkDefinition

Namespace: Unity.MARS

Syntax

public class LandmarkDefinition

Constructors

LandmarkDefinition(String, Type, Type)

Create a definition with a single output type

Declaration

public LandmarkDefinition(string name, Type outputType, Type settingsType = null)

Parameters

Type	Name	Description
String	name	The landmark name.
Type	outputType	The output type.
Type	settingsType	The settings type, defaults to none if not specified.

LandmarkDefinition(String, Type[], Type)

Create a definition with multiple types of outputs

Declaration

public LandmarkDefinition(string name, Type[] outputTypes, Type settingsType = null)

Parameters

Type	Name	Description
String	name	The landmark name.
Type[]	outputTypes	The output types.
Type	settingsType	The settings type, defaults to none if not specified.

Fields

name

Declaration

public string name

Field Value

Type	Description
String

outputTypes

Declaration

public Type[] outputTypes

Field Value

Type	Description
Type[]

settingsType

Declaration

public Type settingsType

Field Value

Type	Description
Type

Methods

GetEnumName<TEnum>(Boolean)

Gets the name of a landmark parsed into a certain enum type

Declaration

public TEnum GetEnumName<TEnum>(bool ignoreCase = true)
    where TEnum : struct

Parameters

Type	Name	Description
Boolean	ignoreCase	Whether case should be ignored (default it true)

Returns

Type	Description
TEnum	The name as the given enum type

Type Parameters

Name	Description
TEnum	The enum type