Curvy  4.1.0
SplineInputModuleBase Class Referenceabstract
+ Inheritance diagram for SplineInputModuleBase:
+ Collaboration diagram for SplineInputModuleBase:

Detailed Description

Base class for spline input modules

Properties

CurvySplineSegment EndCP [get, set]
 
CurvySplineSegment StartCP [get, set]
 
bool UseCache [get, set]
 Makes this module use the cached approximations of the spline's positions and tangents 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]
 

Protected Member Functions

bool getPathClosed (CurvySpline spline)
 
float getPathLength (CurvySpline spline)
 
CGData GetSplineData (CurvySpline spline, bool fullPath, CGDataRequestRasterization raster, CGDataRequestMetaCGOptions options)
 
override void OnEnable ()
 
abstract void ValidateStartAndEndCps ()
 Checks that StartCP and EndCp values are correct, and fix them if they are not. More...
 
- Protected Member Functions inherited from CGModule
virtual void Awake ()
 
PrefabPool GetPrefabPool (GameObject prefab)
 
CurvyCGEventArgs OnBeforeRefreshEvent (CurvyCGEventArgs e)
 
virtual void OnDestroy ()
 
virtual void OnDisable ()
 
CurvyCGEventArgs OnRefreshEvent (CurvyCGEventArgs e)
 
void RenameResource (string resourceName, Component resource, int index=-1)
 

Protected Attributes

CurvySplineSegment m_EndCP
 
CurvySplineSegment m_StartCP
 

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

bool getPathClosed ( CurvySpline  spline)
protected
float getPathLength ( CurvySpline  spline)
protected
CGData GetSplineData ( CurvySpline  spline,
bool  fullPath,
CGDataRequestRasterization  raster,
CGDataRequestMetaCGOptions  options 
)
protected
override void OnEnable ( )
protectedvirtual

Reimplemented from CGModule.

abstract void ValidateStartAndEndCps ( )
protectedpure virtual

Checks that StartCP and EndCp values are correct, and fix them if they are not.

Implemented in InputSplinePath.

Member Data Documentation

CurvySplineSegment m_EndCP
protected
CurvySplineSegment m_StartCP
protected

Property Documentation

CurvySplineSegment EndCP
getset
CurvySplineSegment StartCP
getset
bool UseCache
getset

Makes this module use the cached approximations of the spline's positions and tangents


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