Curvy  8.3.0
SplineInputModuleBase Class Reference
+ Inheritance diagram for SplineInputModuleBase:
+ Collaboration diagram for SplineInputModuleBase:

Detailed Description

Base class for spline input modules

Properties

CurvySplineSegment EndCP [get, set]
 If not null, the input spline will not be considered fully, but only the range between StartCP and EndCP. More...
 
abstract CurvySpline InputSpline [get, set]
 
override bool IsConfigured [get]
 
override bool IsInitialized [get]
 
bool PathIsClosed [get]
 
CurvySplineSegment StartCP [get, set]
 If not null, the input spline will not be considered fully, but only the range between StartCP and EndCP. More...
 
bool UseCache [get, set]
 Makes this module use the cached approximations of the spline's positions and tangents More...
 
bool UseGlobalSpace [get, set]
 Whether to use local or global coordinates of the input's control points. Using the global space will dirty the module whenever the spline's transform is updated 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]
 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

void ClearRange ()
 Clear the input range, defined by StartCP and EndCP More...
 
void SetRange (CurvySplineSegment rangeStart, CurvySplineSegment rangeEnd)
 Set the input range, defined by StartCP and EndCP 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

CGData GetSplineData (CurvySpline spline, bool fullPath, CGDataRequestRasterization raster, CGDataRequestMetaCGOptions options)
 
virtual void OnSplineAssigned ()
 
void ValidateStartAndEndCps ()
 
- 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>()
 
- 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

void ClearRange ( )

Clear the input range, defined by StartCP and EndCP

CGData GetSplineData ( CurvySpline  spline,
bool  fullPath,
CGDataRequestRasterization  raster,
CGDataRequestMetaCGOptions  options 
)
protected
virtual void OnSplineAssigned ( )
protectedvirtual

Reimplemented in InputSplineShape.

void SetRange ( CurvySplineSegment  rangeStart,
CurvySplineSegment  rangeEnd 
)

Set the input range, defined by StartCP and EndCP

void ValidateStartAndEndCps ( )
protected

Property Documentation

CurvySplineSegment EndCP
getset

If not null, the input spline will not be considered fully, but only the range between StartCP and EndCP.

Valid values of StartCP and EndCP are such as those CPs are part of InputSpline, and StartCP is prior to EndCP in that spline

abstract CurvySpline InputSpline
getsetprotected
override bool IsConfigured
get
override bool IsInitialized
get
bool PathIsClosed
get
CurvySplineSegment StartCP
getset

If not null, the input spline will not be considered fully, but only the range between StartCP and EndCP.

Valid values of StartCP and EndCP are such as those CPs are part of InputSpline, and StartCP is prior to EndCP in that spline

bool UseCache
getset

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

bool UseGlobalSpace
getset

Whether to use local or global coordinates of the input's control points. Using the global space will dirty the module whenever the spline's transform is updated


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