Class CGModuleInputSlot

Namespace

FluffyUnderware.Curvy.Generator

Class defining a module's input slot

[Serializable]
public class CGModuleInputSlot : CGModuleSlot

Inheritance

object

CGModuleSlot

CGModuleInputSlot

Inherited Members

CGModuleSlot.Module

CGModuleSlot.Info

CGModuleSlot.Origin

CGModuleSlot.DropZone

CGModuleSlot.CanvasSpaceDropZone

CGModuleSlot.IsLinked

CGModuleSlot.OnRequestModule

CGModuleSlot.PathProvider

CGModuleSlot.ExternalInput

CGModuleSlot.LinkedSlots

CGModuleSlot.Count

CGModuleSlot.Name

CGModuleSlot.mLinkedSlots

CGModuleSlot.HasLinkTo(CGModuleSlot)

CGModuleSlot.GetLinkedModules()

CGModuleSlot.LinkInputAndOutput(CGModuleSlot, CGModuleSlot)

CGModuleSlot.UnlinkAll()

CGModuleSlot.ReInitializeLinkedSlots()

CGModuleSlot.SetInfoFromField(FieldInfo)

CGModuleSlot.ToString()

Properties

InputInfo

public InputSlotInfo InputInfo { get; }

Property Value

InputSlotInfo

IsOnRequest

Does this slot receive/provide data only on demand, as opposed to on refresh?

public override bool IsOnRequest { get; }

Property Value

bool

See Also

IOnRequestProcessing

Methods

CanLinkTo(CGModuleSlot)

Can a link be established between this slot and the other link?

public override bool CanLinkTo(CGModuleSlot other)

Parameters

other CGModuleSlot

Returns

bool

GetAllData<T>(params CGDataRequestParameter[])

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

[NotNull]
public List<T> GetAllData<T>(params CGDataRequestParameter[] requests) where T : CGData

Parameters

requests CGDataRequestParameter[]

request parameters

Returns

List<T>

the data

Type Parameters

T

type of requested data

GetAllData<T>(out bool, params CGDataRequestParameter[])

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

[NotNull]
public List<T> GetAllData<T>(out bool isDataDisposable, params CGDataRequestParameter[] requests) where T : CGData

Parameters

isDataDisposable bool

Whether the returned data can be disposed safely after using it, in order to make its resources available for future use, and thus reducing garbage collection. It is set to false when returned data is a direct reference to data stored by the module, and not a copy of it Dispose(bool) ArrayPool<T>

requests CGDataRequestParameter[]

request parameters

Returns

List<T>

the data

Type Parameters

T

type of requested data

GetData<T>(params CGDataRequestParameter[])

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

[CanBeNull]
public T GetData<T>(params CGDataRequestParameter[] requests) where T : CGData

Parameters

requests CGDataRequestParameter[]

request parameters

Returns

T

the data

Type Parameters

T

type of requested data

GetData<T>(out bool, params CGDataRequestParameter[])

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

[CanBeNull]
public T GetData<T>(out bool isDataDisposable, params CGDataRequestParameter[] requests) where T : CGData

Parameters

isDataDisposable bool

Whether the returned data can be disposed safely after using it, in order to make its resources available for future use, and thus reducing garbage collection. It is set to false when returned data is a direct reference to data stored by the module, and not a copy of it Dispose(bool) ArrayPool<T>

requests CGDataRequestParameter[]

request parameters

Returns

T

the data

Type Parameters

T

type of requested data

LinkTo(CGModuleSlot)

public override void LinkTo(CGModuleSlot outputSlot)

Parameters

outputSlot CGModuleSlot

LoadLinkedSlots()

protected override void LoadLinkedSlots()

SourceSlot(int)

Gets a linked Output slot

public CGModuleOutputSlot SourceSlot(int index = 0)

Parameters

index int

Returns

CGModuleOutputSlot

UnlinkFrom(CGModuleSlot)

Unlink the current slot from the specified other slot.

public override void UnlinkFrom(CGModuleSlot outputSlot)

Parameters

outputSlot CGModuleSlot