Curvy  8.4.0
ResourceExportingModule Class Referenceabstract
+ Inheritance diagram for ResourceExportingModule:
+ Collaboration diagram for ResourceExportingModule:

Detailed Description

A CGModule that creates managed resources that can be exported

Public Member Functions

GameObject SaveToScene (Transform parent=null)
 Save the created resource(s) to the scene More...
 
- 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< CGModuleLinkGetInputLinks (CGModuleInputSlot inSlot)
 
CGModuleInputSlot GetInputSlot (string name)
 
List< CGModuleInputSlotGetInputSlots (System.Type filterType=null)
 
bool GetManagedResources (out List< Component > components, out List< string > resourceNames)
 
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 ()
 

Protected Member Functions

abstract GameObject SaveResourceToScene (Component managedResource, Transform newParent)
 Save a specific resource to the scene as a GameObject More...
 
- 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)
 

Additional Inherited Members

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

abstract GameObject SaveResourceToScene ( Component  managedResource,
Transform  newParent 
)
protectedpure virtual

Save a specific resource to the scene as a GameObject

Returns
The saved GameObject

Implemented in CreateMesh, and CreateGameObject.

GameObject SaveToScene ( Transform  parent = null)

Save the created resource(s) to the scene

Parameters
parentthe parent transform to which the saved resource(s) GameObject(s) will be attached. If null, saved resource(s) GameObject(s) will be at the hierarchy's root
Returns
The created GameObject

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