m usage |
Add info |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=CameraFrustumMeshComponent.png | |Image=CameraFrustumMeshComponent.png | ||
|Name=Camera Frustum Mesh | |Name=Camera Frustum Mesh | ||
}} | }} | ||
The Camera Frustum Mesh is a component that can be used in a [[Component:MeshRenderer|Mesh Renderer]] to visualize the limits and view cone of a [[Component:Camera|Camera]] | |||
<!--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}} | ||
|Profile|ColorProfile| | |Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}} | ||
|Orientation|FloatQ| Direction the mesh is facing. | |Orientation|FloatQ| Direction the mesh is facing. | ||
|Near|Float| Slices the mesh to demonstrate camera nearclip | |Near|Float| Slices the mesh to demonstrate camera nearclip | ||
|Far|Float| Expands the mesh to demonstrate camera farclip. | |Far|Float| Expands the mesh to demonstrate camera farclip. | ||
|HorizontalAngle|Float| | |HorizontalAngle|Float| The horizontal FOV of the camera represented by this mesh. | ||
|VerticalAngle|Float| | |VerticalAngle|Float| The Vertical FOV of the camera represented by this mesh. | ||
|DualSided|Bool| Enables the mesh to be dual sided. | |DualSided|Bool| Enables the mesh to be dual sided. | ||
|NearCap|Bool| | |NearCap|Bool| Whether or not the end closest to the camera should be capped with a quad. | ||
|FarCap|Bool| | |FarCap|Bool| Whether or not the end furthest from the camera should be capped with a quad. | ||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}} | |||
}} | }} | ||
Line 35: | Line 40: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Camera Frustum Mesh]] | [[Category:Components{{#translation:}}|Camera Frustum Mesh]] | ||
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Camera Frustum Mesh]] | [[Category:Components:Assets:Procedural Meshes{{#translation:}}|Camera Frustum Mesh]] |
Latest revision as of 15:44, 6 November 2024
Component image
The Camera Frustum Mesh is a component that can be used in a Mesh Renderer to visualize the limits and view cone of a Camera
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 that the vertex colors for this mesh should be displayed in. |
Orientation
|
FloatQ | Direction the mesh is facing. |
Near
|
Float | Slices the mesh to demonstrate camera nearclip |
Far
|
Float | Expands the mesh to demonstrate camera farclip. |
HorizontalAngle
|
Float | The horizontal FOV of the camera represented by this mesh. |
VerticalAngle
|
Float | The Vertical FOV of the camera represented by this mesh. |
DualSided
|
Bool | Enables the mesh to be dual sided. |
NearCap
|
Bool | Whether or not the end closest to the camera should be capped with a quad. |
FarCap
|
Bool | Whether or not the end furthest from the camera should be capped with a quad. |
Sync Delegates
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
The CameraFrustumMesh is used alongside the InteractiveCamera to visualize the range of the camera.