Component:BoundingBoxDriver: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page BoundingBoxDriver (Component) to Component:BoundingBoxDriver: Creating component Namespace
Add info
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BoundingBoxDriverComponent.png
|Image=BoundingBoxDriverComponent.png
|Name=Bounding Box Driver
|Name=Bounding Box Driver
}}
}}
The '''BoundingBoxDriver''' component is commonly used in Basic text objects to size the collider based on the text. This takes any [[Type:IBounded|IBounded]] and turns its Bounding box data into its local space center point and local space size. This is useful for auto generating the size and center of a [[Component:BoxCollider]] around a procedural mesh.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|BoundedSource|IBounded|
|BoundedSource|{{RootFieldType|RelayRef`1|[[Type:IBounded|IBounded]]}}|TypeAdv0=true| The object to get Bounding box data from.
|Size|IField`1|TypeString1=IField<float3>|
|Size|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv1=true| The field to drive with the local space size of the bounding box of <code>BoundedSource</code>.
|Center|IField`1|TypeString2=IField<float3>|
|Center|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv2=true|The field to drive with the local space center of the bounding box of <code>BoundedSource</code>.
|Padding|Float3|
|Padding|Float3| how much to add to the output of <code>Size</code>
|Scale|Float3|
|Scale|Float3| how much to multiply the output of <code>Size</code>
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach to a slot and provide <code>BoundedSource</code>. The output fields are best used to drive a [[Component:BoxCollider]].


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:BoxCollider]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Bounding Box Driver]]
[[Category:Components{{#translation:}}|Bounding Box Driver]]
[[Category:Components:Transform:Drivers{{#translation:}}|Bounding Box Driver]]
[[Category:Components:Transform:Drivers{{#translation:}}|Bounding Box Driver]]

Latest revision as of 15:47, 11 November 2024

Component image 
Bounding Box Driver component as seen in the Scene Inspector

The BoundingBoxDriver component is commonly used in Basic text objects to size the collider based on the text. This takes any IBounded and turns its Bounding box data into its local space center point and local space size. This is useful for auto generating the size and center of a Component:BoxCollider around a procedural mesh.

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.
BoundedSource direct RelayRef`1<IBounded> The object to get Bounding box data from.
Size field drive of Float3 The field to drive with the local space size of the bounding box of BoundedSource.
Center field drive of Float3 The field to drive with the local space center of the bounding box of BoundedSource.
Padding Float3 how much to add to the output of Size
Scale Float3 how much to multiply the output of Size

Usage

Attach to a slot and provide BoundedSource. The output fields are best used to drive a Component:BoxCollider.

Examples

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


See Also