Inheritance diagram for CGModule:

Collaboration diagram for CGModule:

Detailed Description

Curvy Generator module base class

Public Attributes
List< CGModuleLink >	InputLinks = new List<CGModuleLink>()

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

CGModuleProperties	Properties = new CGModuleProperties()

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

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

Public Member Functions
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 ()

Protected Member Functions
virtual void	Awake ()

CurvyCGEventArgs	OnBeforeRefreshEvent (CurvyCGEventArgs e)

virtual void	OnDestroy ()

virtual void	OnDisable ()

virtual void	OnEnable ()

CurvyCGEventArgs	OnRefreshEvent (CurvyCGEventArgs e)

Static Protected Member Functions
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

Component AddManagedResource	(	string	resourceName,
		string	context = `""`,
		int	index = `-1`
	)

virtual void Awake ( )

protectedvirtual

CGModule CopyTo ( CurvyGenerator targetGenerator )

void Delete ( )

virtual bool DeleteAllOutputManagedResources ( )

virtual

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

Returns: True if there were deleted resources

Reimplemented in CreateMesh, and CreateGameObject.

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 )

static T GetRequestParameter< T > ( ref CGDataRequestParameter[] requests )

staticprotected

Gets a request parameter of a certain type

Template Parameters

T	Type derived from PCGDataRequestParameter

Parameters

requests reference to the list of request parameters

Returns: the wanted request parameter or null

Type Constraints

T

:

CGDataRequestParameter

void Initialize ( )

bool IsManagedResource ( Component res )

CurvyCGEventArgs OnBeforeRefreshEvent ( CurvyCGEventArgs e )

protected

virtual void OnDestroy ( )

protectedvirtual

virtual void OnDisable ( )

protectedvirtual

virtual void OnEnable ( )

protectedvirtual

CurvyCGEventArgs OnRefreshEvent ( CurvyCGEventArgs e )

protected

virtual void OnStateChange ( )

virtual

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

Reimplemented in BuildVolumeSpots.

virtual void OnTemplateCreated ( )

virtual

Called after a module was copied to a template

Use this handle references that can't be templated etc...

Reimplemented in InputMesh, InputGameObject, and InputSplinePath.

virtual void Refresh ( )

virtual

Add Module processing code in here

Reimplemented in CreateMesh, BuildShapeExtrusion, BuildVolumeSpots, BuildVolumeMesh, BuildRasterizedPath, BuildVolumeCaps, CreateGameObject, InputTransformSpots, GameObjectToMesh, DeformMesh, InputSpots, InputGameObject, InputMesh, CreatePathLineRenderer, and ModifierTRSMesh.

void ReInitializeLinkedSlots ( )

static void RemoveRequestParameter	(	ref CGDataRequestParameter[]	requests,
		CGDataRequestParameter	request
	)

staticprotected

Removes a certain request parameter from the requests array

Parameters

requests	reference to the requests array
request	the request to remove

virtual void Reset ( )

virtual

Reimplemented in DeformMesh, and DebugRasterizedPath.

Member Data Documentation

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

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

CGModuleProperties Properties = new CGModuleProperties()

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

Property Documentation

bool Active

getset

bool CircularReferenceError

getset

Whether this module has circular reference errors

bool Dirty

getset

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

virtual bool IsInitialized

get

Gets whether the module and all its dependencies are fully initialized

string ModuleName

getset

CurvyCGEvent OnBeforeRefresh

getset

CurvyCGEvent OnRefresh

getset

List<CGModuleOutputSlot> Output

get

Dictionary<string, CGModuleOutputSlot> OutputByName

get

bool RandomizeSeed

getset

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

int Seed

getset

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

int UniqueID

get

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

Curvy/Scripts/CG/CGModule.cs

Detailed Description

Public Attributes

Properties

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Member Function Documentation

Member Data Documentation

Property Documentation