ControllerElementIdentifier Class |
Represents a single element on a controller. Used to identify physical elements on controllers by type and name.
Inheritance HierarchySystemObject
RewiredControllerElementIdentifier
RewiredControllerElementIdentifier
Namespace: Rewired
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public sealed class ControllerElementIdentifier
The ControllerElementIdentifier type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ControllerElementIdentifier |
Constructor.
|
| ControllerElementIdentifier(ControllerElementIdentifier) |
Copy constructor.
|
Properties| Name | Description | |
|---|---|---|
 | compoundElementType |
If this element identifier is a compound element, the type of compound element it represents.
|
| elementType |
The controller element type this element identifier represents.
|
| glyph |
The glyph for the element identifier.
This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
|
| id | |
| key |
The key of the element identifier.
This is used for localization and glyph lookup.
|
| name |
The name of the element identifier.
The returned value will be localized if localization is in use.
|
| negativeGlyph |
The glyph for the negative axis of the element identifier.
This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
|
| negativeKey |
The key of the negative axis of the element identifier, if any.
This is used for localization and glyph lookup.
|
| negativeName |
The name of the negative axis of the element identifier, if any.
If this is an axis element and no negative name was defined, name will be returned with a - suffix appended.
The returned value will be localized if localization is in use.
|
| positiveGlyph |
The glyph for the positive axis of the element identifier.
This will only return a glyph if a glyph provider is in use and a glyph has been defined for this element identifier.
|
| positiveKey |
The key of the positive axis of the element identifier, if any.
This is used for localization and glyph lookup.
|
| positiveName |
The name of the positive axis of the element identifier, if any.
If this is an axis element and no positive name was defined, name will be returned with a + suffix appended.
The returned value will be localized if localization is in use.
|
Methods| Name | Description | |
|---|---|---|
| Clone | |
| GetDisplayName(AxisRange) |
Gets the display name for the specified range.
The returned value will be localized if localization is in use.
|
| GetDisplayName(ControllerElementType, AxisRange) |
Gets the display name for the specified element type and range.
The returned value will be localized if localization is in use.
|
| GetFinalGlyphKey(AxisRange) |
Gets the full glyph key path for the specified range.
This will only return a value if a glyph was found.
|
| GetFinalGlyphKey(ControllerElementType, AxisRange) |
Gets the full glyph key path for the specified element type and range.
This will only return a value if a glyph was found.
|
| GetGlyph(AxisRange) |
Gets the glyph for the specified range.
|
| GetGlyph(ControllerElementType, AxisRange) |
Gets the glyph for the specified element type and range.
|
See Also