Catlike Coding
Unity Code Documentation
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
CatlikeCoding.NumberFlow.Function Class Reference

Base class for NumberFlow functions. Extend to create your own custom functions. More...

Public Member Functions

 Function ()
 Initialize a new instance of the CatlikeCoding.NumberFlow.Function class. More...
 
virtual void Compute (Value output, Value[] arguments)
 Override this method to perform your computation. More...
 
virtual void ComputeCoordinate (Value output, Diagram diagram)
 Override this method to perform your coordinate-based computation. More...
 

Public Attributes

string menuName
 Menu name. More...
 
string name
 Function name. More...
 
string[] propertyNames
 Property names. More...
 
ValueType[] propertyTypes
 Property types. More...
 
ValueType returnType = ValueType.Float
 Type of the return value. More...
 
FunctionType type = FunctionType.Function
 Function type. More...
 

Protected Member Functions

virtual void Configure ()
 Override this method to configure your function. More...
 

Detailed Description

Base class for NumberFlow functions. Extend to create your own custom functions.

Constructor & Destructor Documentation

CatlikeCoding.NumberFlow.Function.Function ( )

Initialize a new instance of the CatlikeCoding.NumberFlow.Function class.

Member Function Documentation

virtual void CatlikeCoding.NumberFlow.Function.Compute ( Value  output,
Value[]  arguments 
)
virtual

Override this method to perform your computation.

Parameters
outputValue object used to store the output.
argumentsValue objects used as arguments.
virtual void CatlikeCoding.NumberFlow.Function.ComputeCoordinate ( Value  output,
Diagram  diagram 
)
virtual

Override this method to perform your coordinate-based computation.

Parameters
outputValue object used to store the output.
diagramDiagram to retrieve coordinates from.
virtual void CatlikeCoding.NumberFlow.Function.Configure ( )
protectedvirtual

Override this method to configure your function.

Member Data Documentation

string CatlikeCoding.NumberFlow.Function.menuName

Menu name.

string CatlikeCoding.NumberFlow.Function.name

Function name.

string [] CatlikeCoding.NumberFlow.Function.propertyNames

Property names.

ValueType [] CatlikeCoding.NumberFlow.Function.propertyTypes

Property types.

ValueType CatlikeCoding.NumberFlow.Function.returnType = ValueType.Float

Type of the return value.

FunctionType CatlikeCoding.NumberFlow.Function.type = FunctionType.Function

Function type.