A control layout specifies the composition of an input control.
Inheritance
System.Object
InputControlLayout
public class InputControlLayout
Fields
Declaration
public const string VariantSeparator = ";"
Field Value
Type |
Description |
System.String |
|
Properties
Declaration
public IEnumerable<InternedString> appliedOverrides { get; }
Property Value
Type |
Description |
System.Collections.Generic.IEnumerable<InternedString> |
|
Declaration
public IEnumerable<InternedString> baseLayouts { get; }
Property Value
Type |
Description |
System.Collections.Generic.IEnumerable<InternedString> |
|
Declaration
public ReadOnlyArray<InternedString> commonUsages { get; }
Property Value
Declaration
public ReadOnlyArray<InputControlLayout.ControlItem> controls { get; }
Property Value
Declaration
public static InternedString DefaultVariant { get; }
Property Value
Declaration
public string displayName { get; }
Property Value
Type |
Description |
System.String |
|
Declaration
public bool hideInUI { get; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public bool isControlLayout { get; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public bool isDeviceLayout { get; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public bool isGenericTypeOfDevice { get; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public InputControlLayout.ControlItem this[string path] { get; }
Parameters
Type |
Name |
Description |
System.String |
path |
|
Property Value
Declaration
public InternedString name { get; }
Property Value
Declaration
public FourCC stateFormat { get; }
Property Value
Declaration
public int stateSizeInBytes { get; }
Property Value
Type |
Description |
System.Int32 |
|
Declaration
public Type type { get; }
Property Value
Type |
Description |
System.Type |
|
Declaration
public bool updateBeforeRender { get; }
Property Value
Type |
Description |
System.Boolean |
|
Declaration
public InternedString variants { get; }
Property Value
Methods
Declaration
public InputControlLayout.ControlItem? FindControl(InternedString path)
Parameters
Returns
Declaration
public InputControlLayout.ControlItem? FindControlIncludingArrayElements(string path, out int arrayIndex)
Parameters
Type |
Name |
Description |
System.String |
path |
|
System.Int32 |
arrayIndex |
|
Returns
Declaration
public static InputControlLayout FromJson(string json)
Parameters
Type |
Name |
Description |
System.String |
json |
|
Returns
Declaration
public static InputControlLayout FromType(string name, Type type)
Parameters
Type |
Name |
Description |
System.String |
name |
|
System.Type |
type |
|
Returns
Return the type of values produced by controls created from the layout.
Declaration
public Type GetValueType()
Returns
Type |
Description |
System.Type |
The value type of the control or null if it cannot be determined.
|
Merge the settings from other
into the layout such that they become
the base settings.
Declaration
public void MergeLayout(InputControlLayout other)
Parameters
Declaration
Returns
Type |
Description |
System.String |
|