Curvy  6.1.0
ConformPath Class Reference
+ Inheritance diagram for ConformPath:
+ Collaboration diagram for ConformPath:

Public Attributes

CGModuleInputSlot InPath = new CGModuleInputSlot()
CGModuleOutputSlot OutPath = new CGModuleOutputSlot()
- 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>()


Vector3 Direction [get, set]
 The direction to raycast in More...
LayerMask LayerMask [get, set]
 The layers to raycast against More...
float MaxDistance [get, set]
 The maximum raycast distance More...
float Offset [get, set]
 Defines an offset shift along the raycast direction More...
bool PathIsClosed [get]
float PathLength [get]
bool Warp [get, set]
 If enabled, the entire path is moved to the nearest possible distance. If disabled, each path point is moved individually 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]
int Seed [get, set]
int UniqueID [get]
- Properties inherited from IOnRequestPath
float PathLength [get]
- Properties inherited from IPathProvider
bool PathIsClosed [get]

Public Member Functions

CGData[] OnSlotDataRequest (CGModuleInputSlot requestedBy, CGModuleOutputSlot requestedSlot, params CGDataRequestParameter[] requests)
- 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 OnStateChange ()
 Called when a module's state changes (Link added/removed, Active toggles etc..) More...
virtual void OnTemplateCreated ()
 Called after a module was copied to a template More...
virtual void Refresh ()
 Add Module processing code in here More...
void ReInitializeLinkedSlots ()
virtual void Reset ()

Static Public Member Functions

static CGPath Conform (Transform pathTransform, CGPath path, LayerMask layers, Vector3 projectionDirection, float offset, float rayLength, bool warp)
 Confirms a path by projecting it on top of objects (with a collider) of a specific layer More...

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

static CGPath Conform ( Transform  pathTransform,
CGPath  path,
LayerMask  layers,
Vector3  projectionDirection,
float  offset,
float  rayLength,
bool  warp 

Confirms a path by projecting it on top of objects (with a collider) of a specific layer

warpIf true, the projected path will keep its shape
CGData [] OnSlotDataRequest ( CGModuleInputSlot  requestedBy,
CGModuleOutputSlot  requestedSlot,
params CGDataRequestParameter[]  requests 

Implements IOnRequestProcessing.

Member Data Documentation

Property Documentation

Vector3 Direction

The direction to raycast in

LayerMask LayerMask

The layers to raycast against

float MaxDistance

The maximum raycast distance

float Offset

Defines an offset shift along the raycast direction

bool PathIsClosed
float PathLength
bool Warp

If enabled, the entire path is moved to the nearest possible distance. If disabled, each path point is moved individually

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