Curvy  7.1.0
BuildVolumeSpots Class Reference
+ Inheritance diagram for BuildVolumeSpots:
+ Collaboration diagram for BuildVolumeSpots:

Public Attributes

CGModuleInputSlot InBounds = new CGModuleInputSlot()
 
CGModuleInputSlot InPath = new CGModuleInputSlot()
 
CGModuleOutputSlot OutSpots = new CGModuleOutputSlot()
 
CGSpots SimulatedSpots
 
- Public Attributes inherited from CGModule
List< CGModuleLinkInputLinks = new List<CGModuleLink>()
 
List< CGModuleLinkOutputLinks = new List<CGModuleLink>()
 
CGModuleProperties Properties = new CGModuleProperties()
 
List< string > UIMessages = new List<string>()
 

Properties

int[] BoundsIndices [get]
 
GUIContent[] BoundsNames [get]
 
int Count [get]
 
float CrossBase [get, set]
 Shifts the Cross origin value by a constant value More...
 
AnimationCurve CrossCurve [get, set]
 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

See also
Range

) and 1 (its end) More...

 
int FirstRepeating [get, set]
 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 More...
 
bool FitEnd [get, set]
 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 More...
 
int GroupCount [get]
 
List< CGBoundsGroupGroups [get, set]
 
int LastRepeating [get, set]
 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 More...
 
FloatRegion Range [get, set]
 
CurvyRepeatingOrderEnum RepeatingOrder [get, set]
 
bool Simulate [get, set]
 Set to true to dry run without actually creating spots More...
 
bool UseBuggedRng [get, set]
 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 More...
 
bool UseVolume [get, set]
 If the source is a Volume you can choose if you want to use it's path or the volume More...
 
- Properties inherited from CGModule
bool Active [get, set]
 
bool CircularReferenceError [get, set]
 Whether this module has circular reference errors More...
 
bool Dirty [get, set]
 
CurvyGenerator Generator [get]
 
ModuleInfoAttribute Info [get]
 
List< CGModuleInputSlotInput [get]
 
Dictionary< string, CGModuleInputSlotInputByName [get]
 
virtual bool IsConfigured [get]
 Gets whether the module is properly configured i.e. has everything to work like intended More...
 
virtual bool IsInitialized [get]
 Gets whether the module and all its dependencies are fully initialized More...
 
string ModuleName [get, set]
 
CurvyCGEvent OnBeforeRefresh [get, set]
 
CurvyCGEvent OnRefresh [get, set]
 
List< CGModuleOutputSlotOutput [get]
 
Dictionary< string, CGModuleOutputSlotOutputByName [get]
 
bool RandomizeSeed [get, set]
 If is set to false, Seed is used to initialize Unity's random numbers generator before refreshing the current module. If set to true, a random seed will be used More...
 
int Seed [get, set]
 If RandomizeSeed is set to false, Seed is used to initialize Unity's random numbers generator before refreshing the If RandomizeSeed is set to true, a random seed will be used current module More...
 
int UniqueID [get]
 

Public Member Functions

CGBoundsGroup AddGroup (string name)
 
void Clear ()
 
override void OnStateChange ()
 Called when a module's state changes (Link added/removed, Active toggles etc..) More...
 
override void Refresh ()
 Add Module processing code in here More...
 
void RemoveGroup (CGBoundsGroup group)
 
- Public Member Functions inherited from CGModule
Component AddManagedResource (string resourceName, string context="", int index=-1)
 
CGModule CopyTo (CurvyGenerator targetGenerator)
 
void Delete ()
 
void DeleteAllPrefabPools ()
 
void DeleteManagedResource (string resourceName, Component res, string context="", bool dontUsePool=false)
 
List< IPool > GetAllPrefabPools ()
 
CGModuleLink GetInputLink (CGModuleInputSlot inSlot, CGModuleOutputSlot outSlot)
 
List< CGModuleLinkGetInputLinks (CGModuleInputSlot inSlot)
 
CGModuleInputSlot GetInputSlot (string name)
 
List< CGModuleInputSlotGetInputSlots (System.Type filterType=null)
 
bool GetManagedResources (out List< Component > components, out List< string > componentNames)
 
CGModuleLink GetOutputLink (CGModuleOutputSlot outSlot, CGModuleInputSlot inSlot)
 
List< CGModuleLinkGetOutputLinks (CGModuleOutputSlot outSlot)
 
CGModuleOutputSlot GetOutputSlot (string name)
 
List< CGModuleOutputSlotGetOutputSlots (System.Type filterType=null)
 
void Initialize ()
 
bool IsManagedResource (Component res)
 
virtual void OnTemplateCreated ()
 Called after a module was copied to a template More...
 
void ReInitializeLinkedSlots ()
 
virtual void Reset ()
 

Additional Inherited Members

- Protected Member Functions inherited from CGModule
virtual void Awake ()
 
PrefabPool GetPrefabPool (GameObject prefab)
 
CurvyCGEventArgs OnBeforeRefreshEvent (CurvyCGEventArgs e)
 
virtual void OnDestroy ()
 
virtual void OnDisable ()
 
virtual void OnEnable ()
 
CurvyCGEventArgs OnRefreshEvent (CurvyCGEventArgs e)
 
void RenameResource (string resourceName, Component resource, int index=-1)
 
- Static Protected Member Functions inherited from CGModule
static T GetRequestParameter< T > (ref CGDataRequestParameter[] requests)
 Gets a request parameter of a certain type More...
 
static void RemoveRequestParameter (ref CGDataRequestParameter[] requests, CGDataRequestParameter request)
 Removes a certain request parameter from the requests array More...
 
- Protected Attributes inherited from CGModule
CurvyCGEvent m_OnBeforeRefresh = new CurvyCGEvent()
 
CurvyCGEvent m_OnRefresh = new CurvyCGEvent()
 

Member Function Documentation

CGBoundsGroup AddGroup ( string  name)
void Clear ( )
override void OnStateChange ( )
virtual

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

Reimplemented from CGModule.

override void Refresh ( )
virtual

Add Module processing code in here

Reimplemented from CGModule.

void RemoveGroup ( CGBoundsGroup  group)

Member Data Documentation

CGSpots SimulatedSpots

Property Documentation

int [] BoundsIndices
get
GUIContent [] BoundsNames
get
int Count
get
float CrossBase
getset

Shifts the Cross origin value by a constant value

AnimationCurve CrossCurve
getset

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

See also
Range

) and 1 (its end)

int FirstRepeating
getset

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

bool FitEnd
getset

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

int GroupCount
get
List<CGBoundsGroup> Groups
getset
int LastRepeating
getset

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

FloatRegion Range
getset
CurvyRepeatingOrderEnum RepeatingOrder
getset
bool Simulate
getset

Set to true to dry run without actually creating spots

bool UseBuggedRng
getset

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

bool UseVolume
getset

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


The documentation for this class was generated from the following file: