Interface IBuildingBlock
A Building Block defines a reusable block developers will be using often in their applications. To accelerate development and improve the user experience, these Building Blocks are regrouped in a common overlay in the Scene View allowing the user to easily access and drop these elements in the current scene. Implement this interface to define a Building Block. In order to add this block to the UI, this Building Block should either be returned by an GetBuildingBlocks() enumerable (common case), or else identified as an unsectioned Building Block by directly using the BuildingBlockItemAttribute on the Building Block class.
Namespace: Unity.XR.CoreUtils.Editor.BuildingBlocks
Assembly: Unity.XR.CoreUtils.Editor.dll
Syntax
public interface IBuildingBlock
Properties
IconPath
The path to the icon of this Building Block in the UI. This icon should be placed in a Resources folder.
Declaration
string IconPath { get; }
Property Value
Type | Description |
---|---|
string |
Id
The name of this Building Block. This id will be used to show this Building Block in the UI.
Declaration
string Id { get; }
Property Value
Type | Description |
---|---|
string |
IsEnabled
Whether the user know if this Building Block is enabled or disabled. If disabled, the Building Block will be grayed out in the UI.
Declaration
bool IsEnabled { get; }
Property Value
Type | Description |
---|---|
bool |
Tooltip
Description of the Building Block. This description will be displayed as a tooltip in the UI.
Declaration
string Tooltip { get; }
Property Value
Type | Description |
---|---|
string |
Methods
ExecuteBuildingBlock()
Implement this method to execute the actions associated to this Building Block.
Declaration
void ExecuteBuildingBlock()