Curvy  6.0.0
SlotInfo Class Reference
+ Inheritance diagram for SlotInfo:
+ Collaboration diagram for SlotInfo:

Detailed Description

Attribute to define slot properties

Public Types

enum  SlotArrayType { Unknown, Normal, Hidden }
 Defines what type of Array is used More...
 

Public Attributes

bool Array
 Whether or not the slot accepts an array of CGData instances or a single instance of it More...
 
SlotArrayType ArrayType = SlotArrayType.Normal
 When Array is true, this value defines what type of Array is used More...
 
readonly Type[] DataTypes
 
string Name
 If empty Field's name will be used, with slight modifications More...
 
string Tooltip
 

Properties

string DisplayName [get, set]
 If not null, this string will be used in the UI, while Name will be used in the data serialization and slots linking logic More...
 

Public Member Functions

int CompareTo (object obj)
 

Protected Member Functions

 SlotInfo (string name, params Type[] type)
 
 SlotInfo (params Type[] type)
 

Member Enumeration Documentation

enum SlotArrayType
strong

Defines what type of Array is used

Enumerator
Unknown 
Normal 

An array that behaves like an array code wise and UI wise

Hidden 

An array that behave like an array code wise, but is displayed as a single instance of CGData UI wise. This allows for CG modules to send/receive arrays, without giving the user the possibility to link multiple modules to the slot

Constructor & Destructor Documentation

SlotInfo ( string  name,
params Type[]  type 
)
protected
SlotInfo ( params Type[]  type)
protected

Member Function Documentation

int CompareTo ( object  obj)

Member Data Documentation

bool Array

Whether or not the slot accepts an array of CGData instances or a single instance of it

When Array is true, this value defines what type of Array is used

readonly Type [] DataTypes
string Name

If empty Field's name will be used, with slight modifications

string Tooltip

Property Documentation

string DisplayName
getset

If not null, this string will be used in the UI, while Name will be used in the data serialization and slots linking logic


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