Table of Contents

Class SplineInputModuleBase

Namespace
FluffyUnderware.Curvy.Generator

Base class for spline input modules

public abstract class SplineInputModuleBase : CGModule
Inheritance
Object
Component
Behaviour
MonoBehaviour
DTVersionedMonoBehaviour
SplineInputModuleBase
Derived
Inherited Members

Properties

EndCP

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

public CurvySplineSegment EndCP { get; set; }

Property Value

CurvySplineSegment

Remarks

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

InputSpline 

protected abstract CurvySpline InputSpline { get; set; }

Property Value

CurvySpline

IsConfigured

Gets whether the module is properly configured i.e. has everything to work like intended

public override bool IsConfigured { get; }

Property Value

bool

IsInitialized

Gets whether the module and all its dependencies are fully initialized

public override bool IsInitialized { get; }

Property Value

bool

PathIsClosed 

public bool PathIsClosed { get; }

Property Value

bool

StartCP

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

public CurvySplineSegment StartCP { get; set; }

Property Value

CurvySplineSegment

Remarks

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

UseCache

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

public bool UseCache { get; set; }

Property Value

bool

UseGlobalSpace

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

public bool UseGlobalSpace { get; set; }

Property Value

bool

Methods

ClearRange()

Clear the input range, defined by StartCP and EndCP

public void ClearRange()

GetSplineData(CurvySpline, bool, CGDataRequestRasterization, CGDataRequestMetaCGOptions) 

[CanBeNull]
protected CGData GetSplineData(CurvySpline spline, bool fullPath, CGDataRequestRasterization raster, CGDataRequestMetaCGOptions options)

Parameters

spline CurvySpline
fullPath bool
raster CGDataRequestRasterization
options CGDataRequestMetaCGOptions

Returns

CGData

OnSplineAssigned() 

protected virtual void OnSplineAssigned()

SetRange(CurvySplineSegment, CurvySplineSegment)

Set the input range, defined by StartCP and EndCP

public void SetRange(CurvySplineSegment rangeStart, CurvySplineSegment rangeEnd)

Parameters

rangeStart CurvySplineSegment
rangeEnd CurvySplineSegment

ValidateStartAndEndCps() 

protected void ValidateStartAndEndCps()