Inheritance diagram for ConformPath:

Collaboration diagram for ConformPath:

Public Attributes
CGModuleInputSlot	InPath = new CGModuleInputSlot()

CGModuleOutputSlot	OutPath = new CGModuleOutputSlot()

Public Attributes inherited from CGModule
List< CGModuleLink >	InputLinks = new List<CGModuleLink>()

List< CGModuleLink >	OutputLinks = new List<CGModuleLink>()

CGModuleProperties	Properties = new CGModuleProperties()

List< string >	UIMessages = new List<string>()

Properties
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]`

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< CGModuleInputSlot >	Input `[get]`

Dictionary< string, CGModuleInputSlot >	InputByName `[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< CGModuleOutputSlot >	Output `[get]`

Dictionary< string, CGModuleOutputSlot >	OutputByName `[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]`

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 ()

virtual bool	DeleteAllOutputManagedResources ()
	Delete all the managed resources acting as an output. One example of this are the generated meshes by the FluffyUnderware.Curvy.Generator.Modules.CreateMesh module More...

void	DeleteAllPrefabPools ()

void	DeleteManagedResource (string resourceName, Component res, [NotNull] string context="", bool dontUsePool=false)

List< IPool >	GetAllPrefabPools ()

CGModuleLink	GetInputLink (CGModuleInputSlot inSlot, CGModuleOutputSlot outSlot)

List< CGModuleLink >	GetInputLinks (CGModuleInputSlot inSlot)

CGModuleInputSlot	GetInputSlot (string name)

List< CGModuleInputSlot >	GetInputSlots (System.Type filterType=null)

bool	GetManagedResources (out List< Component > components, out List< string > resourceNames)

CGModuleLink	GetOutputLink (CGModuleOutputSlot outSlot, CGModuleInputSlot inSlot)

List< CGModuleLink >	GetOutputLinks (CGModuleOutputSlot outSlot)

CGModuleOutputSlot	GetOutputSlot (string name)

List< CGModuleOutputSlot >	GetOutputSlots (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 void	Conform (CGPath path, Transform pathTransform, LayerMask layers, Vector3 projectionDirection, float offset, float rayLength, bool warp)
	Conforms a path by projecting it on top of objects (with a collider) of a specific layer More...

static CGPath	Conform (Transform pathTransform, CGPath path, LayerMask layers, Vector3 projectionDirection, float offset, float rayLength, bool warp)
	Conforms 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 ()

CurvyCGEventArgs	OnBeforeRefreshEvent (CurvyCGEventArgs e)

virtual void	OnDestroy ()

virtual void	OnDisable ()

virtual void	OnEnable ()

CurvyCGEventArgs	OnRefreshEvent (CurvyCGEventArgs e)

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...

Member Function Documentation

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

static

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

Parameters

pathTransform
path
layers
projectionDirection
offset
rayLength
warp	If true, the projected path will keep its shape

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

static

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

Parameters

pathTransform
path
layers
projectionDirection
offset
rayLength
warp	If true, the projected path will keep its shape

Returns: The same path as the input parameter 'path'

CGData [] OnSlotDataRequest	(	CGModuleInputSlot	requestedBy,
		CGModuleOutputSlot	requestedSlot,
		params CGDataRequestParameter[]	requests
	)

Implements IOnRequestProcessing.

Member Data Documentation

CGModuleInputSlot InPath = new CGModuleInputSlot()

CGModuleOutputSlot OutPath = new CGModuleOutputSlot()

Property Documentation

Vector3 Direction

getset

The direction to raycast in

LayerMask LayerMask

getset

The layers to raycast against

float MaxDistance

getset

The maximum raycast distance

float Offset

getset

Defines an offset shift along the raycast direction

bool PathIsClosed

get

bool Warp

getset

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:

Curvy/Scripts/CG Modules/ConformPath.cs

Public Attributes

Properties

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation