Component:LegacyColorDialog: Difference between revisions

From Resonite Wiki
Newer edit →
Visual
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Legacy Color Dialog
|Name=Legacy Color Dialog
}}
}}
{{stub}}
The '''LegacyColorDialog''' component is used in old Legacy content that was migrated and was used to pick colors for color fields. This component should not be used and should be replaced whenever possible.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Realtime|Bool|
|Realtime|Bool| Whether this component should instantly update the value of the target field in <code>TargetField</code>
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv1=true|
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv1=true| The color field this component is editing.
|_originalColor|ColorX|
|_originalColor|ColorX| The original color value <code>TargetField</code>'s target field had before editing.
|_hue|Float|
|_hue|Float| The current selected color hue.
|_saturation|Float|
|_saturation|Float| The current selected color saturation.
|_value|Float|
|_value|Float| The current selected color value.
|_alpha|Float|
|_alpha|Float| The current selected color transparency.
|_profile|ColorProfile|
|_profile|ColorProfile| The current selected color profile.
|_gain|Float|
|_gain|Float| The current selected color gain.
|_rSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv9=true|
|_rSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv9=true| The slider to change the red of the color with.
|_gSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv10=true|
|_gSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv10=true| The slider to change the green of the color with.
|_bSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv11=true|
|_bSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv11=true| The slider to change the blue of the color with.
|_aSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv12=true|
|_aSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv12=true| The slider to change the transparency/alpha of the color with.
|_gainSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv13=true|
|_gainSlider|'''[[Component:LegacySlider|LegacySlider]]'''|TypeAdv13=true| The slider to change the gain of the color with.
|_rValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv14=true|
|_rValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv14=true| The field to drive with the current selected red value.
|_gValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv15=true|
|_gValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv15=true| The field to drive with the current selected green value.
|_bValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv16=true|
|_bValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv16=true| The field to drive with the current selected blue value.
|_aValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv17=true|
|_aValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv17=true| The field to drive with the current selected transparency/alpha value.
|_gainValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv18=true|
|_gainValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv18=true| The field to drive with the current selected gain value.
|_colorWheelMesh|'''[[Component:ColorWheelTriangleMesh|ColorWheelTriangleMesh]]'''|TypeAdv19=true|
|_colorWheelMesh|'''[[Component:ColorWheelTriangleMesh|ColorWheelTriangleMesh]]'''|TypeAdv19=true| The triangle color mesh for this UI.
|_okButton|'''[[Component:LegacyButton|LegacyButton]]'''|TypeAdv20=true|
|_okButton|'''[[Component:LegacyButton|LegacyButton]]'''|TypeAdv20=true| The button that when pressed applies the selected color and closes the UI.
|_cancelButton|'''[[Component:LegacyButton|LegacyButton]]'''|TypeAdv21=true|
|_cancelButton|'''[[Component:LegacyButton|LegacyButton]]'''|TypeAdv21=true| The button that when pressed reverts the value of the targeted field in <code>TargetField</code> to <code>_originalColor</code> and closes the ui.
|_style|'''[[Component:LegacyUIStyle|LegacyUIStyle]]'''|TypeAdv22=true|
|_style|'''[[Component:LegacyUIStyle|LegacyUIStyle]]'''|TypeAdv22=true| {{Template:LegacyUI_Style}}
}}
}}


== Behavior ==
== Usage ==
Just don't.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 40: Line 42:
[[Category:Components:UI:Dialogs{{#translation:}}|Legacy Color Dialog]]
[[Category:Components:UI:Dialogs{{#translation:}}|Legacy Color Dialog]]
[[Category:Components{{#translation:}}|Legacy Color Dialog]]
[[Category:Components{{#translation:}}|Legacy Color Dialog]]
[[Category:ComponentStubs]]

Revision as of 20:15, 21 January 2025

Component image 
Legacy Color Dialog component as seen in the Scene Inspector

The LegacyColorDialog component is used in old Legacy content that was migrated and was used to pick colors for color fields. This component should not be used and should be replaced whenever possible.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Realtime Bool Whether this component should instantly update the value of the target field in TargetField
TargetField direct RelayRef`1<IField`1<ColorX>> The color field this component is editing.
_originalColor ColorX The original color value TargetField's target field had before editing.
_hue Float The current selected color hue.
_saturation Float The current selected color saturation.
_value Float The current selected color value.
_alpha Float The current selected color transparency.
_profile ColorProfile The current selected color profile.
_gain Float The current selected color gain.
_rSlider LegacySlider The slider to change the red of the color with.
_gSlider LegacySlider The slider to change the green of the color with.
_bSlider LegacySlider The slider to change the blue of the color with.
_aSlider LegacySlider The slider to change the transparency/alpha of the color with.
_gainSlider LegacySlider The slider to change the gain of the color with.
_rValue field drive of Float The field to drive with the current selected red value.
_gValue field drive of Float The field to drive with the current selected green value.
_bValue field drive of Float The field to drive with the current selected blue value.
_aValue field drive of Float The field to drive with the current selected transparency/alpha value.
_gainValue field drive of Float The field to drive with the current selected gain value.
_colorWheelMesh ColorWheelTriangleMesh The triangle color mesh for this UI.
_okButton LegacyButton The button that when pressed applies the selected color and closes the UI.
_cancelButton LegacyButton The button that when pressed reverts the value of the targeted field in TargetField to _originalColor and closes the ui.
_style LegacyUIStyle The source of the legacy color styles for this component.

Usage

Just don't.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:LegacyColorDialog&oldid=94835"