View source for Bake Reflection Probes (LogiX node)/en

<languages></languages>
{{Infobox Logix Node
| Name = Bake Reflection Probes
| Image =[[File: BakeReflectionProbes.png | noframe | 128px | 'Bake Reflection Probes' LogiX node ]]
| Input0Type = Impulse | Input0Name = Bake
| Input1Type = Slot | Input1Name = Root
| Input2Type = Bool | Input2Name = BakeInactive
| Input3Type = String | Input3Name = FilterWithTag
| Input4Type = Float | Input4Name = DelayBeforeBake
| Output0Type = Impulse | Output0Name = OnBakeBatchStart
| Output1Type = Impulse | Output1Name = OnBeforeProbeBake
| Output2Type = Impulse | Output2Name = OnProbeBaked
| Output3Type = Impulse | Output3Name = OnBakeBatchFinished
| Output4Type = Bool | Output4Name = IsBaking
| Output5Type = ReflectionProbe | Output5Name = CurrentProbe
| Output6Type = Int | Output6Name = CurrentProbeIndex
| Output7Type = Int | Output7Name = CurrentProbeCount
}}

The '''Bake Reflection Probes''' node will (re-)bake the cubemaps for all ReflectionProbe components under the input Root slot's heirarchy when an impulse is received at <code>Bake</code>.

== Usage ==
The <code>Root</code> input defines the slot hierarchy which will be searched for ReflectionProbe components to bake. Default is the world root slot.


The <code>BakeInactive</code> input determines whether disabled ReflectionProbe components, or ones present on inactive slots, will be baked. Default is false.


The <code>FilterWithTag</code> input determines can be used to only bake ReflectionProbes on slots with an exactly matching tag. This is empty by default which results in no tag-based filtering.


The <code>DelayBeforeBake</code> input determines the delay between baking successive ReflectionProbes in seconds. Default is 0.25 seconds.


The <code>OnBakeBatchStart</code> output fires an impulse when baking starts. No impulse will be fired if there is no valid (or empty) <code>Root</code> input, however it is not required that there be any valid ReflectionProbes to bake for an impulse to be fired.


The <code>OnBakeBatchStart</code> output fires an impulse immediately before the batch baking starts. No impulse will be fired if there is no valid (or empty) <code>Root</code> input, however it is not required that there be any valid ReflectionProbes to bake for an impulse to be fired.


The <code>OnBeforeProbeBake</code> output fires an impulse immediately before baking begins for each ReflectionProbe.


The <code>OnProbeBaked</code> output fires an impulse after each individual ReflectionProbe has been baked.


The <code>OnBakeBatchFinished</code> output fires an impulse after all valid ReflectionProbes have been baked.


The <code>IsBaking</code> output indicates whether a batch baking operation is in progress.


The <code>CurrentProbe</code> output provides the ReflectionProbe component which is currently being processed. This value is only available during the impulse chains started from <code>OnBeforeProbeBake</code> and <code>OnProbeBaked</code>.


The <code>CurrentProbeIndex</code> output provides the index of the ReflectionProble currently being processed. This value is 0 for the first probe baked in the batch, 1 for the next one and so on. The value from this output is 0 during the impulse chain started from <code>OnBakeBatchStart</code> and equal to the maximum index during the impulse chain started from <code>OnBakeBatchFinished</code>. The value will be correct for the specific ReflectionProbe processed during the impulse chains started from <code>OnBeforeProbeBake</code> and <code>OnProbeBaked</code>.


The <code>CurrentProbeCount</code> output provides the total number of ReflectionProbes which will be baked during the batch. This value is available during the impulse chains started from <code>OnBeforeProbeBake</code>, <code>OnProbeBaked</code>, and <code>OnBakeBatchFinished</code>.


Note that the node will not initate another baking batch if one is currently in progress.

== Examples ==

== Node Menu ==
[[Category:LogiX{{#translation:}}|Bake Reflection Probess]]
[[Category:LogiX:Rendering{{#translation:}}|Bake Reflection Probess]]
{{NodeMenu-Rendering}}