Table of Contents

Class BuildVolumeSpots

Namespace
FluffyUnderware.Curvy.Generator.Modules
public class BuildVolumeSpots : CGModule
Inheritance
Object
Component
Behaviour
MonoBehaviour
DTVersionedMonoBehaviour
BuildVolumeSpots
Inherited Members

Constructors

BuildVolumeSpots() 

public BuildVolumeSpots()

Fields

InBounds 

[HideInInspector]
[InputSlotInfo(typeof(CGBounds), Array = true)]
public CGModuleInputSlot InBounds

Field Value

CGModuleInputSlot

InPath 

[HideInInspector]
[InputSlotInfo(typeof(CGPath), Name = "Path/Volume", DisplayName = "Volume/Rasterized Path")]
public CGModuleInputSlot InPath

Field Value

CGModuleInputSlot

OutSpots 

[HideInInspector]
[OutputSlotInfo(typeof(CGSpots))]
public CGModuleOutputSlot OutSpots

Field Value

CGModuleOutputSlot

SimulatedSpots 

public CGSpots SimulatedSpots

Field Value

CGSpots

Properties

Count 

public int Count { get; }

Property Value

int

CrossBase

Shifts the Cross origin value by a constant value

public float CrossBase { get; set; }

Property Value

float

CrossCurve

Shifts the Cross origin value by a value that varies along the Volume's length. The Curve's X axis has values between 0 (start of the Range) and 1 (its end)

public AnimationCurve CrossCurve { get; set; }

Property Value

AnimationCurve

FirstRepeating

First index of the range of groups that will be placed repetitively along the volume. Groups that are not in this range will be placed only once

public int FirstRepeating { get; set; }

Property Value

int

FitEnd

If true, the last non repeating group is placed exactly at the end of the volume used for spots. If not, the last group is placed at the first available spot, which might leave some space between it and the end of the volume

public bool FitEnd { get; set; }

Property Value

bool

GroupCount 

public int GroupCount { get; }

Property Value

int

Groups 

public List<CGBoundsGroup> Groups { get; set; }

Property Value

List<CGBoundsGroup>

LastRepeating

Last index of the range of groups that will be placed repetitively along the volume. Groups that are not in this range will be placed only once

public int LastRepeating { get; set; }

Property Value

int

Range 

public FloatRegion Range { get; set; }

Property Value

FloatRegion

RepeatingOrder 

public CurvyRepeatingOrderEnum RepeatingOrder { get; set; }

Property Value

CurvyRepeatingOrderEnum

Simulate

Set to true to dry run without actually creating spots

public bool Simulate { get; set; }

Property Value

bool

UseBuggedRng

Until version 6.3.1, this module had a bug in the computation of the randomized values. Set this to true to keep that bugged behaviour if your project depends on it

public bool UseBuggedRng { get; set; }

Property Value

bool

UseVolume

If the source is a Volume you can choose if you want to use it's path or the volume

public bool UseVolume { get; set; }

Property Value

bool

Methods

AddGroup(string) 

public CGBoundsGroup AddGroup(string name)

Parameters

name string

Returns

CGBoundsGroup

Clear() 

public void Clear()

OnAfterDeserialize()

Implementation of UnityEngine.ISerializationCallbackReceiver Called automatically by Unity, is not meant to be called by Curvy's users

public void OnAfterDeserialize()

OnBeforeSerialize()

Implementation of UnityEngine.ISerializationCallbackReceiver Called automatically by Unity, is not meant to be called by Curvy's users

public void OnBeforeSerialize()

OnStateChange()

Called when a module's state changes (Link added/removed, Active toggles etc..)

public override void OnStateChange()

Refresh()

Add Module processing code in here

public override void Refresh()

RemoveGroup(CGBoundsGroup) 

public void RemoveGroup(CGBoundsGroup group)

Parameters

group CGBoundsGroup