fix |
templates templates templates |
||
Line 5: | Line 5: | ||
{{stub}} | {{stub}} | ||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| | |_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}} | ||
|TipReference|Slot| | |TipReference|Slot| {{Template:ITool TipReference}} | ||
|BlockGripEquip|Bool| | |BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}} | ||
|BlockRemoteEquip|Bool| | |BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}} | ||
|EquipName|String| | |EquipName|String| {{Template:ITool EquipName}} | ||
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| | |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | ||
|_gripPosesGenerated|Bool| | |_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | ||
|FixedMinimumPointDistance|Float| | |FixedMinimumPointDistance|Float| {{Template:Brush_FixedMinimumPointDistance}} | ||
|PositionSmoothing|Float| | |PositionSmoothing|Float| {{Template:Brush_PositionSmoothing}} | ||
|RotationSmoothing|Float| | |RotationSmoothing|Float| {{Template:Brush_RotationSmoothing}} | ||
|PressureSmoothing|Float| | |PressureSmoothing|Float| {{Template:Brush_PressureSmoothing}} | ||
|MaxStrokeLength|Float| | |MaxStrokeLength|Float| {{Template:Brush_MaxStrokeLength}} | ||
|StrokeFadeInLength|Float| | |StrokeFadeInLength|Float| {{Template:Brush_StrokeFadeInLength}} | ||
|StrokeFadeOutLength|Float| | |StrokeFadeOutLength|Float| {{Template:Brush_StrokeFadeOutLength}} | ||
|StrokeGroupFinishWaitTime|Float| | |StrokeGroupFinishWaitTime|Float|{{Template:Brush_StrokeGroupFinishWaitTime}} | ||
|ActivationThreshold|Float| | |ActivationThreshold|Float| {{Template:Brush_ActivationThreshold}} | ||
|DeactivationThresholdRatio|Float| | |DeactivationThresholdRatio|Float| {{Template:Brush_DeactivationThresholdRatio}} | ||
|MenuSizeChange|Float| | |MenuSizeChange|Float|{{Template:Brush_MenuSizeChange}} | ||
|SnapTip|Bool| | |SnapTip|Bool| {{Template:Brush_SnapTip}} | ||
|SnapLine|Bool| | |SnapLine|Bool| {{Template:Brush_SnapLine}} | ||
|StrokesSpace|{{RootFieldType|RootSpace}}|TypeAdv20=true| | |StrokesSpace|{{RootFieldType|RootSpace}}|TypeAdv20=true| {{Template:Brush_StrokesSpace}} | ||
|MakeStrokesGrabbable|Bool| | |MakeStrokesGrabbable|Bool| {{Template:Brush_MakeStrokesGrabbable}} | ||
|PositionStrokesToTip|Bool| | |PositionStrokesToTip|Bool| {{Template:Brush_PositionStrokesToTip}} | ||
|OrientStrokesToTip|Bool| | |OrientStrokesToTip|Bool| {{Template:Brush_OrientStrokesToTip}} | ||
|ScaleStrokesToUser|Bool| | |ScaleStrokesToUser|Bool| {{Template:Brush_ScaleStrokesToUser}} | ||
|PickMaterials|Bool| | |PickMaterials|Bool| {{Template:Brush_PickMaterials}} | ||
|PickColors|Bool| | |PickColors|Bool| {{Template:Brush_PickColors}} | ||
|CurrentMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv27=true| | |CurrentMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv27=true| {{Template:Brush_CurrentMaterial}} | ||
|ColorMappings|{{RootFieldType|SyncList`1|[[Type:ColorMapping|ColorMapping]]}}|TypeAdv28=true| | |ColorMappings|{{RootFieldType|SyncList`1|[[Type:ColorMapping|ColorMapping]]}}|TypeAdv28=true| {{Template:Brush_ColorMappings}} | ||
|ParticleSystem|'''[[Component:LegacyParticleSystem|LegacyParticleSystem]]'''|TypeAdv29=true| | |ParticleSystem|'''[[Component:LegacyParticleSystem|LegacyParticleSystem]]'''|TypeAdv29=true| {{Template:Brush_ParticleSystem}} | ||
|MeshEmitterTemplate|'''[[Component:LegacyMeshEmitter|LegacyMeshEmitter]]'''|TypeAdv30=true| | |MeshEmitterTemplate|'''[[Component:LegacyMeshEmitter|LegacyMeshEmitter]]'''|TypeAdv30=true| {{Template:Brush_MeshEmitterTemplate}} | ||
|ParticleTemplateHandling|TemplateHandling| | |ParticleTemplateHandling|TemplateHandling| {{Template:Brush_ParticleTemplateHandling}} | ||
|EmissionRatePerUnitLength|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv32=true| | |EmissionRatePerUnitLength|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv32=true| {{Template:Brush_EmissionRatePerUnitLength}} | ||
|_colorPicker|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv33=true| | |_colorPicker|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv33=true| {{Template:Brush__colorPicker}} | ||
|_pickedColor|ColorX| | |_pickedColor|ColorX| {{Template:Brush__pickedColor}} | ||
|_hideOnStroke|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv35=true| | |_hideOnStroke|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv35=true| {{Template:Brush__hideOnStroke}} | ||
|_lastUsedMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv36=true| | |_lastUsedMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv36=true| {{Template:Brush__lastUsedMaterial}} | ||
|_lastCreatedMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv37=true| | |_lastCreatedMaterial|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv37=true| {{Template:Brush__lastCreatedMaterial}} | ||
|Pressure|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv38=true| | |Pressure|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv38=true| {{Template:Brush_Pressure}} | ||
|Position|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv39=true| | |Position|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv39=true| {{Template:Brush_Position}} | ||
|Rotation|{{RootFieldType|RawOutput`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv40=true| | |Rotation|{{RootFieldType|RawOutput`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv40=true| {{Template:Brush_Rotation}} | ||
|LastPointDelta|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv41=true| | |LastPointDelta|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv41=true| {{Template:Brush_LastPointDelta}} | ||
|Velocity|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv42=true| | |Velocity|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv42=true| {{Template:Brush_Velocity}} | ||
|RawDelta|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv43=true| | |RawDelta|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv43=true| {{Template:Brush_RawDelta}} | ||
|RawVelocity|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv44=true| | |RawVelocity|{{RootFieldType|RawOutput`1|[[Type:Float3|Float3]]}}|TypeAdv44=true| {{Template:Brush_RawVelocity}} | ||
|RawStrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv45=true| | |RawStrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv45=true| {{Template:Brush_RawStrokeLength}} | ||
|StrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv46=true| | |StrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv46=true| {{Template:Brush_StrokeLength}} | ||
|NormalizedStrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv47=true| | |NormalizedStrokeLength|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv47=true| {{Template:Brush_NormalizedStrokeLength}} | ||
|StrokeFadeMultiplier|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv48=true| | |StrokeFadeMultiplier|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv48=true| {{Template:Brush_}} | ||
|StrokeGroupIndex|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv49=true| | |StrokeGroupIndex|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv49=true| {{Template:Brush_StrokeGroupIndex}} | ||
|MinHullPointDistance|Double| | |MinHullPointDistance|Double| | ||
|FlatShading|Bool| | |FlatShading|Bool| | ||
Line 63: | Line 63: | ||
|MaterialPreviews|{{RootFieldType|SyncRefList`1|[[Component:MeshRenderer|MeshRenderer]]}}|TypeAdv54=true| | |MaterialPreviews|{{RootFieldType|SyncRefList`1|[[Component:MeshRenderer|MeshRenderer]]}}|TypeAdv54=true| | ||
|_currentHull|'''[[Component:ConvexHullMesh|ConvexHullMesh]]'''|TypeAdv55=true| | |_currentHull|'''[[Component:ConvexHullMesh|ConvexHullMesh]]'''|TypeAdv55=true| | ||
|_previewMesh|{{RootFieldType|DriveRef`1|[[Component:ConvexHullMesh|ConvexHullMesh]]}}|TypeAdv56=true| | |_previewMesh|{{RootFieldType|DriveRef`1|[[Component:ConvexHullMesh|ConvexHullMesh]]}}|TypeAdv56=true| {{Template:Brush__previewMesh}} | ||
|_previewMeshOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv57=true| | |_previewMeshOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv57=true| {{Template:Brush__previewMeshOffset}} | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == |
Revision as of 01:15, 11 January 2025
Component image 
Convex Hull Brush Tool component as seen in the Scene Inspector

This article or section is a Stub. You can help the Resonite Wiki by expanding it.
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. |
_equipLink
|
direct LinkTarget`1<ITool> | This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to. |
TipReference
|
Slot | The slot to use as the tool's tip, instead of the component's slot. |
BlockGripEquip
|
Bool | Whether to prevent legacy double grip equipping from equipping this tooltip. |
BlockRemoteEquip
|
Bool | Whether to prevent equipping by clicking via laser |
EquipName
|
String | The name of the tool in the context menu when equipping via context menu. |
_overrideActiveTool
|
InteractionHandler | The interaction handler to use instead of this tool as an interaction handler. |
_gripPosesGenerated
|
Bool | Whether the Grip Pose Reference components and slots have been generated for this tool. |
FixedMinimumPointDistance
|
Float | Stroke point distances within a stroke cannot be less than this value. |
PositionSmoothing
|
Float | How much to smooth the brush tip position when drawing. |
RotationSmoothing
|
Float | How much to smooth the rotation of the brush tip when drawing |
PressureSmoothing
|
Float | How much to smooth the brush pressure being applied |
MaxStrokeLength
|
Float | The longest a Brush stroke can be before being ended forcibly. |
StrokeFadeInLength
|
Float | The length along the stroke that the stroke fades in. |
StrokeFadeOutLength
|
Float | The length along the stroke that the stroke fades out. |
StrokeGroupFinishWaitTime
|
Float | Finishes the group when drawing strokes for more than this many seconds regardless of how full the group is. |
ActivationThreshold
|
Float | When pressure/strength is above this value, the tool starts drawing. |
DeactivationThresholdRatio
|
Float | When pressure/strength is below this value, the tool stops drawing. |
MenuSizeChange
|
Float | How much to increment or decrement the brush size when using the context menu controls. |
SnapTip
|
Bool | Whether the brush tip should snap to snappers like planes or snap spheres. |
SnapLine
|
Bool | Whether to snap new lines to snappers like snap planes or snap spheres. |
StrokesSpace
|
direct RootSpace | The space to create new strokes into. |
MakeStrokesGrabbable
|
Bool | Make new strokes grabbable. |
PositionStrokesToTip
|
Bool | Position the slots of new stroke groups to the brush tip. |
OrientStrokesToTip
|
Bool | Make the rotation of new stroke group slots oriented to the brush tip. |
ScaleStrokesToUser
|
Bool | Whether the brush strokes should be scaled up or down to match the user's scale. |
PickMaterials
|
Bool | Whether this brush can pick a material by dipping the brush tip in a material orb. |
PickColors
|
Bool | Whether this tool can pick colors by dipping the brush tip into a material orb. |
CurrentMaterial
|
Material | The current material the brush is using to draw. |
ColorMappings
|
list of ColorMapping | Associates materials with their color fields. |
ParticleSystem
|
LegacyParticleSystem | The Particle system to Template when making Particle strokes. |
MeshEmitterTemplate
|
LegacyMeshEmitter | The template component to use as the mesh emitter of new particle emitting strokes. |
ParticleTemplateHandling
|
TemplateHandling | How to handle the use of the Particle system template per new stroke group. |
EmissionRatePerUnitLength
|
Nullable`1<Float> | The rate of particle emission per unit length section of the stroke mesh. |
_colorPicker
|
direct SlotCleanupRef`1<ColorDialogInterface> | The current color picker dialouge being used to pick a color for this brush. |
_pickedColor
|
ColorX | The color that the tool has picked by being dipped in a material orb or picked via a color picker. |
_hideOnStroke
|
list of Slot | The list of slots to hide while making a Brush stroke. |
_lastUsedMaterial
|
Material | The last used material by this brush. |
_lastCreatedMaterial
|
Material | The last material generated by this brush. |
Pressure
|
raw output of Float | The pressure being applied to the brush. |
Position
|
raw output of Float3 | The position of the brush tip after smoothing. |
Rotation
|
raw output of FloatQ | The rotation of the brush tip after smoothing. |
LastPointDelta
|
raw output of Float3 | The difference between the last drawing position and its current position. |
Velocity
|
raw output of Float3 | The velocity of the tool tips position. |
RawDelta
|
raw output of Float3 | The raw delta of the tool tips position. |
RawVelocity
|
raw output of Float3 | The raw velocity of the tool tip. |
RawStrokeLength
|
raw output of Float | The raw stroke length. |
StrokeLength
|
raw output of Float | The current stroke length in meters in StrokesSpace
|
NormalizedStrokeLength
|
raw output of Float | The length of the current stroke from 0->1 where one is maximum length set for this brush for strokes. |
StrokeFadeMultiplier
|
raw output of Float | Template:Brush |
StrokeGroupIndex
|
raw output of Int | The running index of strokes being drawn as part of a stroke group. |
MinHullPointDistance
|
Double | |
FlatShading
|
Bool | |
PointSpread
|
Float | |
TipAnchor
|
Slot | |
MaterialPreviews
|
list of MeshRenderer | |
_currentHull
|
ConvexHullMesh | |
_previewMesh
|
reference drive of ConvexHullMesh | The mesh being used to preview the stroke of this brush. |
_previewMeshOffset
|
field drive of Float3 | The position offset of the mesh preview for this brush. |