Curvy  4.0.0
CGModuleInputSlot Class Reference
+ Inheritance diagram for CGModuleInputSlot:
+ Collaboration diagram for CGModuleInputSlot:

Detailed Description

Class defining a module's input slot

Properties

InputSlotInfo InputInfo [get]
 
- Properties inherited from CGModuleSlot
int Count [get]
 Gets the number of connected links, i.e. shortcut to this.Links.Count More...
 
Rect DropZone [get, set]
 Mouse-Hotzone More...
 
IExternalInput ExternalInput [get]
 Gets (IExternalInput)Module More...
 
SlotInfo Info [get, set]
 Gets the SlotInfo Attribute More...
 
bool IsLinked [get]
 Whether the link is wired or not More...
 
bool IsLinkedAndConfigured [get]
 Whether the link is wired and all connected modules are configured More...
 
List< CGModuleSlotLinkedSlots [get]
 All slots of linked modules More...
 
CGModule Module [get, set]
 The Module this Slot belongs to More...
 
string Name [get]
 
IOnRequestProcessing OnRequestModule [get]
 Gets (IOnRequestProcessing)Module More...
 
IOnRequestPath OnRequestPathModule [get]
 Gets (IOnRequestPath)Module More...
 
Vector2 Origin [get, set]
 Origin of Link-Wire More...
 

Public Member Functions

bool CanLinkTo (CGModuleOutputSlot source)
 Determines if a particular output slot of another module can link to this slot More...
 
 CGModuleInputSlot ()
 
List< T > GetAllData< T > (params CGDataRequestParameter[] requests)
 Gets the data from all modules connected to a certain input slot. More...
 
GetData< T > (params CGDataRequestParameter[] requests)
 Gets the data from the module connected to a certain input slot. If more than one module is connected, the first module's data is returned More...
 
override void LinkTo (CGModuleSlot outputSlot)
 
CGModuleOutputSlot SourceSlot (int index=0)
 Gets a linked Output slot More...
 
override void UnlinkAll ()
 
override void UnlinkFrom (CGModuleSlot outputSlot)
 
- Public Member Functions inherited from CGModuleSlot
 CGModuleSlot ()
 
List< CGModuleGetLinkedModules ()
 Gets a list of all Links' modules More...
 
bool HasLinkTo (CGModuleSlot other)
 
void ReInitializeLinkedSlots ()
 
void ReInitializeLinkedTargetModules ()
 
override string ToString ()
 

Static Public Member Functions

static bool AreInputAndOutputSlotsCompatible (InputSlotInfo inputSlotInfo, bool inputSlotModuleIsOnRequest, OutputSlotInfo outputSlotInfo, bool outputSlotModuleIsOnRequest)
 
- Static Public Member Functions inherited from CGModuleSlot
static implicit operator bool (CGModuleSlot a)
 

Protected Member Functions

override void LoadLinkedSlots ()
 

Additional Inherited Members

- Protected Attributes inherited from CGModuleSlot
List< CGModuleSlotmLinkedSlots = null
 

Constructor & Destructor Documentation

Member Function Documentation

static bool AreInputAndOutputSlotsCompatible ( InputSlotInfo  inputSlotInfo,
bool  inputSlotModuleIsOnRequest,
OutputSlotInfo  outputSlotInfo,
bool  outputSlotModuleIsOnRequest 
)
static

Parameters
inputSlotInfo
inputSlotModuleIsOnRequestDoes the module owning the input slot implement the IOnRequestProcessing interface
outputSlotInfo
outputSlotModuleIsOnRequestDoes the module owning the output slot implement the IOnRequestProcessing interface
Returns
bool CanLinkTo ( CGModuleOutputSlot  source)

Determines if a particular output slot of another module can link to this slot

Parameters
sourcethe slot of the other module that'd like to link to this input slot
Returns
whether linking is allowed or not
List<T> GetAllData< T > ( params CGDataRequestParameter[]  requests)

Gets the data from all modules connected to a certain input slot.

Template Parameters
Ttype of requested data
Parameters
requestsrequest parameters
Returns
the data
Type Constraints
T :CGData 
T GetData< T > ( params CGDataRequestParameter[]  requests)

Gets the data from the module connected to a certain input slot. If more than one module is connected, the first module's data is returned

Template Parameters
Ttype of requested data
Parameters
requestsrequest parameters
Returns
the data
Type Constraints
T :CGData 
override void LinkTo ( CGModuleSlot  outputSlot)
virtual

Reimplemented from CGModuleSlot.

override void LoadLinkedSlots ( )
protectedvirtual

Reimplemented from CGModuleSlot.

CGModuleOutputSlot SourceSlot ( int  index = 0)

Gets a linked Output slot

override void UnlinkAll ( )
virtual

Reimplemented from CGModuleSlot.

override void UnlinkFrom ( CGModuleSlot  outputSlot)
virtual

Reimplemented from CGModuleSlot.

Property Documentation

InputSlotInfo InputInfo
get

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