Component:ColorToColorX: Difference between revisions

Revision as of 15:33, 11 November 2024

Component image

**Color To Color X** component as seen in the Scene Inspector

The ColorToColorX component uses data from a Color and a ColorProfile to drive the value of a ColorX field with optional write back.

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.
`SourceColor`	direct RelayRef`1<IField`1<Color>>	The color to convert into a ColorX for `Target`
`SourceProfile`	direct RelayRef`1<IField`1<ColorProfile>>	The color profile to use for the resulting `Target`
`DefaultProfile`	ColorProfile	the ColorProfile to use for `Target` if `SourceProfile` is empty.
`Target`	field drive of ColorX
`WriteBack`	Bool	Whether to allow changes to the field specified by `Target` to go backwards and affect `DefaultProfile` or `SourceProfile`, and `SourceColor`.

Usage

Attach to a slot and provide SourceColor. Then provide either SourceProfile, or DefaultProfile. The component will then drive a ColorX field through Target.

@@ Line 3: / Line 3: @@
 |Name=Color To Color X
 }}
-{{stub}}
+The '''ColorToColorX''' component uses data from a Color and a ColorProfile to drive the value of a ColorX field with optional write back.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|SourceColor|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Color|Color]]&gt;}}|TypeAdv0=true|
+|SourceColor|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Color|Color]]&gt;}}|TypeAdv0=true| The color to convert into a ColorX for <code>Target</code>
-|SourceProfile|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:ColorProfile|ColorProfile]]&gt;}}|TypeAdv1=true|
+|SourceProfile|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:ColorProfile|ColorProfile]]&gt;}}|TypeAdv1=true| The color profile to use for the resulting <code>Target</code>
-|DefaultProfile|ColorProfile|
+|DefaultProfile|ColorProfile| the ColorProfile to use for <code>Target</code> if <code>SourceProfile</code> is empty.
 |Target|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv3=true|
-|WriteBack|Bool|
+|WriteBack|Bool| Whether to allow changes to the field specified by <code>Target</code> to go backwards and affect <code>DefaultProfile</code> or <code>SourceProfile</code>, and <code>SourceColor</code>.
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot and provide <code>SourceColor</code>. Then provide either <code>SourceProfile</code>, or <code>DefaultProfile</code>. The component will then drive a ColorX field through <code>Target</code>.
 == Examples ==
@@ Line 22: / Line 23: @@
 [[Category:Components:Transform:Drivers{{#translation:}}|Color To Color X]]
 [[Category:Components{{#translation:}}|Color To Color X]]
-[[Category:ComponentStubs]]

Revision as of 15:33, 11 November 2024

Fields

Usage

Examples

See Also