Boing Kit

Appearance

BoingReactorField ​

A volumetric field that accumulates effector influence, sampled per-vertex or per-object via CPU or GPU.

Inherits from: BoingBase

Fields ​

HardwareMode ​

csharp
public BoingReactorField.HardwareModeEnum HardwareMode

Type: BoingReactorField.HardwareModeEnum

Processing hardware used to update the reactor field.

CPU - Update happens on the CPU. Use this mode in conjunction with BoingReactorFieldSampler components.

GPU - Update happens on the GPU. Use this mode in conjunction with shaders.

CellMoveMode ​

csharp
public BoingReactorField.CellMoveModeEnum CellMoveMode

Type: BoingReactorField.CellMoveModeEnum

How cells react when the reactor field center moves around.

Follow - Cells move with the reactor field. Use this mode when a visually shifting field is desired as the field center moves around.

Wrap Around - Cells stay in place and wrap around when the reactor field moves far enough. Use this mode if a visually stationary field is desired as the field center moves around.

CellsX ​

csharp
public int CellsX

Type: int

Number of cells on the X axis.

CellsY ​

csharp
public int CellsY

Type: int

Number of cells on the Y axis.

CellsZ ​

csharp
public int CellsZ

Type: int

Number of cells on the Z axis.

FalloffMode ​

csharp
public BoingReactorField.FalloffModeEnum FalloffMode

Type: BoingReactorField.FalloffModeEnum

How the reactor field influence falls off to zero towards the edges of the field.

None - Constant influence throughout the entire field.

Square - Influence falls off towards the edges along the field's local axes from its center.

Circle - Influence falls off based on the distance from the center of the field.

FalloffDimensions ​

csharp
public BoingReactorField.FalloffDimensionsEnum FalloffDimensions

Type: BoingReactorField.FalloffDimensionsEnum

Which dimensions to apply influence fall-off when sampled by samplers. The dimension left out will act as if samplers are clamped within bounds on that dimension.

e.g. If fall-off dimensions are set to XZ, and the field's maximum Y boundary is 0.5, a sampler at (0.0, 1.0, 0.0) will sample the field as if it's at (0.0, 0.5, 0.0).

EnablePropagation ​

csharp
public bool EnablePropagation

Type: bool

Check to enable propagation of boing effects throughout cells.

AnchorPropagationAtBorder ​

csharp
public bool AnchorPropagationAtBorder

Type: bool

Enable to fix border cells in place.