Component:HollowConeMesh: Difference between revisions

From Resonite Wiki
m Began description of HollowConeMesh with an image
add description, usage
 
(11 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=HollowConeMeshComponent.png
|Image=HollowConeMeshComponent.png
|Name=Hollow Cone Mesh
|Name=Hollow Cone Mesh
}}
}}
The '''HollowConeMesh''' component is used to generate geometry for use with a [[Component:MeshRenderer]]. This component generates a cone with a hollow center with internal geometry and a thickness. Similarly to the [[ConeMesh (Component)|ConeMesh]], the height of this procedural mesh is determined from the center of the object.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|
|HighPriorityIntegration|Bool| {{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|Height|Float|
|Profile|ColorProfile| the profile of the colors of vertices for this mesh.
|OuterRadiusBase|Float|
|Height|Float| how tall the hollow cone should be starting from the center
|InnerRadiusBase|Float|
|OuterRadiusBase|Float| the radius of the bottom ring that makes up the outer tube
|OuterRadiusTop|Float|
|InnerRadiusBase|Float| the radius if the bottom ring that makes up the inner tube
|InnerRadiusTop|Float|
|OuterRadiusTop|Float| the radius of the top ring that makes up the outer tube
|Segments|Int|
|InnerRadiusTop|Float| the radius of the top ring that makes up the inner tube
|UVScale|Float2|
|Segments|Int| how many faces make up each cylinder for the outside and inside.
|UVScale|Float2| how much to multiply the scale of the UVs for the procedural mesh.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach to a slot and insert into a [[Component:MeshRenderer]] to view the geometry. Don't forget to use a [[Material]].


<!--T:4-->Similarly to the [[ConeMesh (Component)|ConeMesh]], the height of this procedural mesh is determined from the center of the object.
<!--T:4-->
== Examples ==
== Examples ==
[[File:HollowConeMesh.png|thumb|2 HollowConeMeshes, one using an alpha material to demonstrate its hollow nature]]<!--T:5-->
[[File:HollowConeMesh.png|thumb|2 HollowConeMeshes, one using an alpha material to demonstrate its hollow nature]]


== Related Components ==
<!--T:5-->
== See Also ==
* [[Component:ConeMesh]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Hollow Cone Mesh]]
[[Category:Components{{#translation:}}|Hollow Cone Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Hollow Cone Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Hollow Cone Mesh]]

Latest revision as of 18:02, 13 November 2024

Component image 
Hollow Cone Mesh component as seen in the Scene Inspector

The HollowConeMesh component is used to generate geometry for use with a Component:MeshRenderer. This component generates a cone with a hollow center with internal geometry and a thickness. Similarly to the ConeMesh, the height of this procedural mesh is determined from the center of the object.

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.
HighPriorityIntegration Bool If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
OverrideBoundingBox Bool Force the bounding box calculated from this component to use OverridenBoundingBox instead of calculating when requested.
OverridenBoundingBox BoundingBox the bounding box this component should say it has when OverrideBoundingBox is enabled. Useful for bounding box calculations with Flux, or changing the selection box for this component when rendered.
Profile ColorProfile the profile of the colors of vertices for this mesh.
Height Float how tall the hollow cone should be starting from the center
OuterRadiusBase Float the radius of the bottom ring that makes up the outer tube
InnerRadiusBase Float the radius if the bottom ring that makes up the inner tube
OuterRadiusTop Float the radius of the top ring that makes up the outer tube
InnerRadiusTop Float the radius of the top ring that makes up the inner tube
Segments Int how many faces make up each cylinder for the outside and inside.
UVScale Float2 how much to multiply the scale of the UVs for the procedural mesh.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
BakeMesh() Action Bake meshes is a sync method that creates a static mesh component with this component, replaces all references to this component with the static mesh component, then deletes this component.

Usage

Attach to a slot and insert into a Component:MeshRenderer to view the geometry. Don't forget to use a Material.

Examples

2 HollowConeMeshes, one using an alpha material to demonstrate its hollow nature

See Also