Toggle에는 이미지와 레이블이 포함됩니다.버튼과 같은 다른 표준 UI 툴킷 컨트롤과 마찬가지로, Toggle에는 MouseUpEvent 및 PointerUpEvent에 등록되는 클릭 가능 매니퓰레이터가 연결되어 있습니다.이러한 이벤트 중 하나가 매니퓰레이터를 트리거하면 Toggle의 값은 true에서 false로 변경되거나 false에서 true로 변경됩니다.현재의 Toggle 값을 읽거나 설정할 수 있습니다.또한 Toggle을 부울 변수에 바인딩할 수도 있습니다.
기본적으로 Toggle 컨트롤은 체크박스로 표시됩니다.일반적인 토글 스위치처럼 보이도록 스타일을 지정할 수 있습니다.
드롭다운의 선택 항목이나 활성화된 옵션과 같이 다른 조건에 따라 요소를 표시하거나 숨길 수 있습니다.조건부 UI의 예로는 Unity 카메라 인스펙터가 있습니다.이는 Physical Camera 모드를 활성화하면 추가 옵션이 표시됩니다.
UI Builder, UXML, C#으로 Toggle을 생성할 수 있습니다.
다음 C# 예시에서는 특정 레이블이 있는 Toggle을 생성합니다.
Toggle myToggle = new Toggle("Click me");
다음 UXML 예시에서는 Toggle을 생성합니다.
[!code-xml[(External/Resources/editor_resources/Assets/Editor Default Resources/UIPackageResources/Snippets/UXML/ToggleSnippet.uxml)]
다음 C# 예시에서는 커스터마이즈 가능한 일부 Toggle 기능을 보여 줍니다.
[!code-cs[(Modules/UIElementsSamplesEditor/Snippets/ToggleSnippet.cs#sample)]
이 예시를 Unity에서 실험해 보려면 Window > UI Toolkit > Samples로 이동합니다.
추가 예시는 다음을 참조하십시오.
C# 클래스:Toggle
네임스페이스:UnityEngine.UIElements
기본 클래스:BaseBoolField
이 요소는 다음 속성을 해당 기본 클래스에서 상속합니다.
| Name | 타입 | 설명 |
|---|---|---|
binding-path |
string |
바인드될 타겟 프로퍼티의 경로입니다. |
focusable |
boolean |
요소에 포커스를 맞출 수 있으면 true입니다. |
label |
string |
필드 옆에 표시될 레이블을 나타내는 문자열입니다. |
tabindex |
int |
포커스 링에서 포커스를 맞출 수 있는 항목을 정렬하는 데 사용되는 정수입니다.0보다 크거나 같아야 합니다. |
text |
string |
BaseBoolField 뒤에 표시되는 선택적 텍스트입니다. Unity는 Label이 존재하지 않는 경우 자동으로 생성합니다. |
value |
boolean |
필드와 연결된 값입니다. |
또한 이 요소는 다음 속성을 VisualElement에서 상속합니다.
| Name | 타입 | 설명 |
|---|---|---|
content-container |
string |
자식 요소가 추가되며, 일반적으로 요소 자체와 동일합니다. |
name |
string |
이 VisualElement의 이름입니다. 이 프로퍼티를 사용하면 특정 요소를 타게팅하는 USS 선택자를 작성할 수 있습니다.요소에 고유한 이름을 부여하는 것이 표준 관행입니다. |
picking-mode |
UIElements.PickingMode |
mouseEvents 또는 IPanel.Pick 쿼리 중에 이 요소를 선택할 수 있는지를 결정합니다. |
style |
string |
이 요소의 스타일 오브젝트에 대한 레퍼런스입니다. USS 파일에서 계산된 데이터 또는 C#에서 이 오브젝트에 작성된 인라인 스타일을 포함합니다. |
tooltip |
string |
사용자가 마우스를 요소 위에 잠시 놓은 후 정보 박스 안에 표시할 텍스트입니다.이는 에디터 UI에서만 지원됩니다. |
usage-hints |
UIElements.UsageHints |
VisualElement에 대한 고수준의 의도된 사용 패턴을 지정하는 힌트 값 조합입니다.이 프로퍼티는 VisualElement가 아직 Panel에 포함되어 있지 않을 때만 설정할 수 있습니다.Panel에 포함되면 이 프로퍼티는 사실상 읽기 전용이 되며, 변경을 시도하면 예외가 발생합니다.적절한 UsageHints를 지정하면 시스템에서 예상하는 사용 패턴에 따라 특정 작업을 처리하거나 가속하는 방법에 대해 더 나은 결정을 내릴 수 있습니다.이러한 힌트는 동작이나 시각적 결과에는 영향을 주지 않으며 패널과 그 안의 요소의 전반적인 성능에만 영향을 줍니다.항상 적절한 UsageHints를 지정하는 것이 좋지만, 일부 UsageHints는 특정 조건(예: 타겟 플랫폼의 하드웨어 제한으로 인해)에서 내부적으로 무시될 수 있다는 점에 유의하십시오. |
view-data-key |
string |
보기 데이터 지속성에 사용됩니다(예: 트리 확장 상태, 스크롤 포지션, 줌 레벨). 이는 보기 데이터 스토어의 보기 데이터를 저장/로드하는 데 사용되는 키입니다.이 키를 설정하지 않으면 이 VisualElement에 대한 지속성이 비활성화됩니다. |
다음 표는 모든 C# 공용 프로퍼티 이름과 관련 USS 선택자의 리스트입니다.
| C# 프로퍼티 | USS 선택자 | 설명 |
|---|---|---|
ussClassName |
.unity-toggle |
토글 요소의 USS 클래스명입니다. Unity는 이 USS 클래스를 토글 요소의 모든 인스턴스에 추가합니다.이 클래스에 적용된 모든 스타일링은 시각적 트리의 스타일시트 옆이나 아래에 있는 모든 토글에 영향을 줍니다. |
labelUssClassName |
.unity-toggle__label |
토글 요소에 있는 레이블의 USS 클래스명입니다. Unity는 토글에 레이블이 없는 경우 Toggle의 Label 하위 요소에 이 USS 클래스를 추가합니다. |
inputUssClassName |
.unity-toggle__input |
토글 요소에 있는 입력 요소의 USS 클래스명입니다. Unity는 이 USS 클래스를 Toggle의 입력 하위 요소에 추가합니다.입력 하위 요소는 매니퓰레이터에 리스폰스를 제공합니다. |
noTextVariantUssClassName |
.unity-toggle--no-text |
텍스트가 없는 토글 요소의 USS 클래스명입니다. Unity는 토글에 레이블이 없는 경우 Toggle에 이 USS 클래스를 추가합니다. |
checkmarkUssClassName |
.unity-toggle__checkmark |
토글 요소에 있는 이미지의 USS 클래스명입니다. Unity는 체크마크 이미지가 포함된 Toggle의 이미지 하위 요소에 이 USS 클래스를 추가합니다. |
textUssClassName |
.unity-toggle__text |
토글 요소에 있는 텍스트 요소의 USS 클래스명입니다. Unity는 이 USS 클래스를 Toggle의 텍스트 하위 요소에 추가합니다. |
mixedValuesUssClassName |
.unity-toggle__mixed-values |
값이 혼합된 토글 요소의 USS 클래스명입니다. Unity는 혼합된 값이 있을 경우 이 USS 클래스를 Toggle의 체크마크에 추가합니다. |
ussClassName |
.unity-base-field |
이 타입 요소의 USS 클래스명입니다. |
labelUssClassName |
.unity-base-field__label |
이 타입의 요소에 있는 레이블의 USS 클래스명입니다. |
inputUssClassName |
.unity-base-field__input |
이 타입의 요소에 있는 입력 요소의 USS 클래스명입니다. |
noLabelVariantUssClassName |
.unity-base-field--no-label |
레이블이 없는 경우 이 타입 요소의 USS 클래스명입니다. |
labelDraggerVariantUssClassName |
.unity-base-field__label--with-dragger |
연결된 드래거가 있는 경우 이 타입의 요소에 있는 레이블의 USS 클래스명입니다. |
mixedValueLabelUssClassName |
.unity-base-field__label--mixed-value |
혼합된 값을 표시하는 요소의 USS 클래스명입니다. |
alignedFieldUssClassName |
.unity-base-field__aligned |
인스펙터 요소에 정렬된 요소의 USS 클래스명입니다. |
disabledUssClassName |
.unity-disabled |
비활성화된 로컬 요소의 USS 클래스명입니다. |
또한 인스펙터 또는 UI 툴킷 디버거의 매칭 선택자 섹션을 사용하여 해당 계층 구조의 모든 레벨에서 VisualElement 컴포넌트에 영향을 주는 USS 선택자를 확인할 수도 있습니다.