Inheritance diagram for CurvyShape:

Collaboration diagram for CurvyShape:

Detailed Description

Base class for CurvyShape components

Public Attributes
bool	Dirty

Properties
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...

Public Member Functions
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
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...

Protected Member Functions
virtual void	ApplyShape ()
	Override this to add custom code More...

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

Member Function Documentation

virtual void ApplyShape ( )

protectedvirtual

Override this to add custom code

Reimplemented in CSStar, CSPie, CSSpiral, CSRoundedRectangle, CSCircle, and CSRectangle.

void Delete ( )

Remove the CurvyShape component from it's GameObject

static string GetShapeName ( System.Type shapeType )

static

Gets Shape Menu Name from a CurvyShape subclass type

Parameters

shapeType

Returns

static List<string> GetShapesMenuNames ( bool only2D = false )

static

Gets a list of Menu Names of available shapes

Parameters

only2D whether to skip 3D shapes or not

Returns: a list of Menu Names

static List<string> GetShapesMenuNames	(	System.Type	currentShapeType,
		out int	currentIndex,
		bool	only2D = `false`
	)

static

Gets a list of Menu Names of available shapes

Parameters

currentShapeType	the current shape type
currentIndex	returns the index of the current shape type
only2D	whether only to show 2D shapes

Returns: a list of Menu Names

static Type GetShapeType ( string menuName )

static

Gets a CurvyShape subclass type from a Shape's MenuName

Parameters

menuName

Returns

void PrepareControlPoints ( int count )

protected

Resizes the spline to have a certain number of Control Points

Parameters

count number of Control Points

void PrepareSpline	(	CurvyInterpolation	interpolation,
		CurvyOrientation	orientation = `CurvyOrientation.Dynamic`,
		int	cachedensity = `50`,
		bool	closed = `true`
	)

protected

Sets basic spline parameters

void Refresh ( )

Called to refresh the shape. Please call base.Refresh() or RefreshSpline() after your custom code!

Warning: Only work with ControlPoints, not with segments

CurvyShape Replace ( string menuName )

Replace the current script with another shape's script

Returns: the new shape script

void SetBezierHandles	(	int	no,
		float	distanceFrag
	)

protected

Sets a Control Point's Bezier Handles by index

Parameters

no	Control point index
distanceFrag	distance in percent

void SetBezierHandles	(	int	no,
		float	inDistanceFrag,
		float	outDistanceFrag
	)

protected

Sets a Control Point's Bezier Handles by index

Parameters

no	Control point index
inDistanceFrag	distance in percent for HandleIn

///

Parameters

outDistanceFrag distance in percent for HandleOut

void SetBezierHandles	(	int	no,
		Vector3	i,
		Vector3	o,
		Space	space = `Space.World`
	)

protected

Sets a Control Point's Bezier Handles position

Parameters

no	the ControlPoint
i	HandlInPosition
o	HandleOutPosition
space	World or local space

static void SetBezierHandles	(	float	distanceFrag,
		bool	setIn,
		bool	setOut,
		params CurvySplineSegment[]	controlPoints
	)

static

Automatically place Bezier handles for a set of Control Points

Parameters

distanceFrag	how much % distance between neighbouring CPs are applied to the handle length?
setIn	Set HandleIn?
setOut	Set HandleOut?
controlPoints	one or more Control Points to set

void SetCGHardEdges ( params int[] controlPoints )

protected

Enables CGHardEdge for a set of Control Points

Parameters

controlPoints list of Control Point indices

void SetPosition	(	int	no,
		Vector3	position
	)

protected

Sets a Control Point's position by index

Parameters

no	Control point index
position	local position

void SetRotation	(	int	no,
		Quaternion	rotation
	)

protected

Sets a Control Point's rotation by index

Parameters

no	Control point index
rotation	local rotation

Member Data Documentation

bool Dirty

Property Documentation

CurvyPlane Plane

getset

Gets or sets the plane to create the shape in

Dictionary<CurvyShapeInfo, System.Type> ShapeDefinitions

staticget

Dictionary of Shape definitions and their types

CurvySpline Spline

get

Gets the attached spline

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

Curvy/Scripts/Shapes/CurvyShape.cs

Detailed Description

Public Attributes

Properties

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

Member Data Documentation

Property Documentation