Curvy  8.4.0
CSSpiral Class Reference
+ Inheritance diagram for CSSpiral:
+ Collaboration diagram for CSSpiral:

Detailed Description

Spiral Spline Shape

Properties

float Circles [get, set]
 
int Count [get, set]
 
float Radius [get, set]
 
AnimationCurve RadiusFactor [get, set]
 
AnimationCurve Z [get, set]
 
- Properties inherited from CurvyShape
CurvyPlane Plane [get, set]
 Gets or sets the plane to create the shape in More...
 
static Dictionary< CurvyShapeInfo, System.Type > ShapeDefinitions [get]
 Dictionary of Shape definitions and their types More...
 
CurvySpline Spline [get]
 Gets the attached spline More...
 

Protected Member Functions

override void ApplyShape ()
 Override this to add custom code More...
 
override void Reset ()
 
- Protected Member Functions inherited from CurvyShape
void PrepareControlPoints (int count)
 Resizes the spline to have a certain number of Control Points More...
 
void PrepareSpline (CurvyInterpolation interpolation, CurvyOrientation orientation=CurvyOrientation.Dynamic, int cachedensity=50, bool closed=true)
 Sets basic spline parameters More...
 
void SetBezierHandles (int no, float distanceFrag)
 Sets a Control Point's Bezier Handles by index More...
 
void SetBezierHandles (int no, float inDistanceFrag, float outDistanceFrag)
 Sets a Control Point's Bezier Handles by index More...
 
void SetBezierHandles (int no, Vector3 i, Vector3 o, Space space=Space.World)
 Sets a Control Point's Bezier Handles position More...
 
void SetCGHardEdges (params int[] controlPoints)
 Enables CGHardEdge for a set of Control Points More...
 
void SetPosition (int no, Vector3 position)
 Sets a Control Point's position by index More...
 
void SetRotation (int no, Quaternion rotation)
 Sets a Control Point's rotation by index More...
 

Additional Inherited Members

- Public Attributes inherited from CurvyShape
bool Dirty
 
- Public Member Functions inherited from CurvyShape
void Delete ()
 Remove the CurvyShape component from it's GameObject More...
 
void Refresh ()
 Called to refresh the shape. Please call base.Refresh() or RefreshSpline() after your custom code! More...
 
CurvyShape Replace (string menuName)
 Replace the current script with another shape's script More...
 
- Static Public Member Functions inherited from CurvyShape
static string GetShapeName (System.Type shapeType)
 Gets Shape Menu Name from a CurvyShape subclass type More...
 
static List< string > GetShapesMenuNames (bool only2D=false)
 Gets a list of Menu Names of available shapes More...
 
static List< string > GetShapesMenuNames (System.Type currentShapeType, out int currentIndex, bool only2D=false)
 Gets a list of Menu Names of available shapes More...
 
static Type GetShapeType (string menuName)
 Gets a CurvyShape subclass type from a Shape's MenuName More...
 
static void SetBezierHandles (float distanceFrag, bool setIn, bool setOut, params CurvySplineSegment[] controlPoints)
 Automatically place Bezier handles for a set of Control Points More...
 

Member Function Documentation

override void ApplyShape ( )
protectedvirtual

Override this to add custom code

Reimplemented from CurvyShape.

override void Reset ( )
protected

Property Documentation

float Circles
getset
int Count
getset
float Radius
getset
AnimationCurve RadiusFactor
getset
AnimationCurve Z
getset

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