Interface IToolsMenuButton
Provides an interface for handling Tools Menu Button functionality
Namespace: UnityEditor.Experimental.EditorVR
Syntax
public interface IToolsMenuButtonProperties
closeButton
Closes this button
Declaration
Func<bool> closeButton { set; }Property Value
| Type | Description |
|---|---|
| Func<Boolean> |
destroy
Destroys this button
Declaration
Action destroy { get; }Property Value
| Type | Description |
|---|---|
| Action |
highlighted
Bool denoting button highlight state
Declaration
bool highlighted { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
hoverExit
Performed when a hover exit is detected on this button
Declaration
Action hoverExit { set; }Property Value
| Type | Description |
|---|---|
| Action |
iconHighlightedLocalZOffset
The z positional offset to apply when button if highlighted
Declaration
float iconHighlightedLocalZOffset { set; }Property Value
| Type | Description |
|---|---|
| Single |
implementsSecondaryButton
Declaration
bool implementsSecondaryButton { set; }Property Value
| Type | Description |
|---|---|
| Boolean |
interactable
Bool denoting button interactable state
Declaration
bool interactable { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
isActiveTool
Bool denoting that this button represents the active tool
Declaration
bool isActiveTool { set; }Property Value
| Type | Description |
|---|---|
| Boolean |
maxButtonCount
The maximum number of buttons that can be displayed by a given ToolsMenu
Declaration
int maxButtonCount { set; }Property Value
| Type | Description |
|---|---|
| Int32 |
order
The order of this button Position/rotation may change according to order
Declaration
int order { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
previewToolDescription
String description of the tool that this button represents
Declaration
string previewToolDescription { set; }Property Value
| Type | Description |
|---|---|
| String |
previewToolType
The type to preview in the button temporarily
Declaration
Type previewToolType { set; }Property Value
| Type | Description |
|---|---|
| Type |
primaryUIContentContainerLocalScale
The scale of the ui content in the primary content container
Declaration
Vector3 primaryUIContentContainerLocalScale { get; set; }Property Value
| Type | Description |
|---|---|
| Vector3 |
secondaryButtonHighlighted
Bool denoting the secondary button highlight state
Declaration
bool secondaryButtonHighlighted { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
selectTool
Selects the tool based on the type assigned to this button
Declaration
Action<Type> selectTool { set; }Property Value
| Type | Description |
|---|---|
| Action<Type> |
showAllButtons
Shows all tool buttons for a given ToolsMenu
Declaration
Action<IToolsMenuButton> showAllButtons { set; }Property Value
| Type | Description |
|---|---|
| Action<IToolsMenuButton> |
stencilRef
Shared stencil ID for all buttons in this menu instance
Declaration
byte stencilRef { set; }Property Value
| Type | Description |
|---|---|
| Byte |
tooltipTarget
Transform used for reference when placing tooltips
Declaration
Transform tooltipTarget { set; }Property Value
| Type | Description |
|---|---|
| Transform |
tooltipVisible
Bool denoting that the tooltip is visible
Declaration
bool tooltipVisible { set; }Property Value
| Type | Description |
|---|---|
| Boolean |
toolType
The toolType assigned to this button
Declaration
Type toolType { get; }Property Value
| Type | Description |
|---|---|
| Type |
visibleButtonCount
Returns the visible button count for a given ToolsMenu used by buttons to position themselves
Declaration
Func<Type, int> visibleButtonCount { set; }Property Value
| Type | Description |
|---|---|
| Func<Type, Int32> |
Events
hovered
Performed when a hover action is detected by this button
Declaration
event Action hoveredEvent Type
| Type | Description |
|---|---|
| Action |