Stock

Persistent numeric identifier used by TonCut to track the object.

property Id: Int64 read GetId write SetId;

Width value stored on the object.

property Width: Cardinal read GetWidth write SetWidth;

Length value stored on the object.

property Length: Cardinal read GetLength write SetLength;

Quantity associated with the current object.

property Quantity: Integer read GetQuantity write SetQuantity;

Maximum stack size or batch size.

property StackSize: Cardinal read GetStackSize write SetStackSize;

Grain or ornament direction associated with the stock item.

property Ornament: TOrnament read GetOrnament write SetOrnament;

External or user-facing identifier stored with the object.

property Identifier: WideString read GetIdentifier write SetIdentifier;

Longer descriptive text stored with the object.

property Description: WideString read GetDescription write SetDescription;

Material linked to the object.

property Material: IMaterial read GetMaterial write SetMaterial;

Rectangle-like edging or margin helper attached to the object.

property Edging: IRectangle read GetEdging;

Per-edge minimum distance exposed as a signed rectangle; a negative side means inherited or unspecified.

property MinEdgeDistance: IRectangle read GetMinEdgeDistance;

Gets or sets the stock priority for this sheet: an integer from cStockPriorityMin to cStockPriorityMax (0 to 100); a higher value is consumed earlier. cStockPriorityLow (0) is the "low" label and cStockPriorityNormal (10) is the default "normal" label. It is a soft signal that factors into the sheet score and only breaks ties in consumption order. Breaking change: this property used to be the TOldStockPriority enum. GetPriority/SetPriority keep the same vtable slots and interface GUID, but the signature changed in place, so a plugin binary built against the previous enum is unsafe to load and must be rebuilt against the current SDK before it runs again.

property Priority: Integer read GetPriority write SetPriority;

Horizontal limit for cut shifting.

property CutShiftHorzLimit: Integer read GetCutShiftHorzLimit write SetCutShiftHorzLimit;

Vertical limit for cut shifting.

property CutShiftVertLimit: Integer read GetCutShiftVertLimit write SetCutShiftVertLimit;

Gets effective cut shift horz limit.

property EffectiveCutShiftHorzLimit: Integer read GetEffectiveCutShiftHorzLimit;

Effective vertical cut-shift limit after host rules are applied.

property EffectiveCutShiftVertLimit: Integer read GetEffectiveCutShiftVertLimit;

Gets or sets extraction cost.

property ExtractionCost: TTcPrice read GetExtractionCost write SetExtractionCost;

Gets or sets this stock item’s own price per square metre, overriding its material’s PricePerSqM for this item alone. cStockPriceAbsent (-1) means no override is set, so the material price applies; any other value, including an explicit 0, must be finite and >= 0. GetPricePerSqM/SetPricePerSqM are new vtable slots appended at the end of the interface, after EndUpdate, under the same interface GUID, so no existing slot moves; every ISheet implementer must add both methods. Engine version 24 carries these slots, and the host refuses a plugin whose EngineVersion does not match, so rebuild plugins against the current SDK.

property PricePerSqM: TTcPrice read GetPricePerSqM write SetPricePerSqM;

Opaque custom text payload stored with the object.

property CustomData: WideString read GetCustomData write SetCustomData;

Mutable access to opaque, implementation-defined algorithm data owned by the current device, material, piece, or stock sheet. No public payload schema or compatibility guarantee is provided.

property AlgorithmData: ITcAlgorithmData read GetAlgorithmData;

Read-only collection of the stock sheet’s defects: damaged material, such as a scratch. A defect is still material, so it can be cut through and may end up inside a remnant or waste, but pieces must not be placed on it. Holes are exposed separately through Holes; both use the ISheetDefects collection type.

property Defects: ISheetDefects read GetDefects;

Read-only collection of holes: areas where the stock (or a remnant, on ISolutionWaste) has no material at all. A hole comes with the stock, is never created by TonCut, is not waste, and is not usable or available area. Support is currently limited. Holes use the same ISheetDefects collection type as defects, but their meaning differs.

property Holes: ISheetDefects read GetHoles;

Remaining quantity currently available.

property AvailableQuantity: Cardinal read GetAvailableQuantity;

Area-like value stored on the object.

property Field: TField read GetField;

Gets field of all.

property FieldOfAll: TField read GetFieldOfAll;

Event fired when the object or collection changes.

property OnChange: INotifyEvent read GetOnChange;

Event fired when an identifier changes.

property OnIdChange: IIdChangeEvent read GetOnIdChange;

Event exposed through OnDefectAdd.

property OnDefectAdd: ISheetDefectChangeEvent read GetOnDefectAdd;

Event exposed through OnDefectRemove.

property OnDefectRemove: ISheetDefectChangeEvent read GetOnDefectRemove;

Event exposed through OnDefectChange.

property OnDefectChange: ISheetDefectChangeEvent read GetOnDefectChange;

Return is standard.

function IsStandard(): Boolean; safecall;

Copy values from another object of the same type.

procedure Assign(const aSheet: ISheet); safecall;

Start a batched update so change notifications can be delayed.

procedure BeginUpdate(); safecall;

Finish a batched update and allow deferred notifications to resume.

procedure EndUpdate(); safecall;

Number of items currently exposed by the interface.

property Count: Integer read GetCount;

Indexed property used to read one item from the collection.

property Items[aIndex: Cardinal]: ISheet read GetByIndex; default;

Area-like value stored on the object.

property Field: TField read GetField;

Remaining quantity currently available.

property AvailableQuantity: Cardinal read GetAvailableQuantity;

Event fired when an item is added.

property OnAdd: ISheetChangeEvent read GetOnAdd;

Event fired when an item is removed.

property OnRemove: ISheetChangeEvent read GetOnRemove;

Event fired when the object or collection changes.

property OnChange: INotifyEvent read GetOnChange;

Create a new sheet instance.

function CreateSheet(): ISheet; safecall;

Add an item or handler.

procedure Add(aSheet: ISheet); safecall;

Delete the item at the specified zero-based index.

procedure DeleteByIndex(aIndex: Cardinal); safecall;

Delete the item with the specified TonCut identifier.

procedure DeleteById(aId: Int64); safecall;

Remove an item or handler.

procedure Remove(const aSheet: ISheet); safecall;

Return the zero-based index of the matching item.

function IndexOf(const aSheet: ISheet): Integer; overload; safecall;

Return the zero-based index of the matching item.

function IndexOf(aId: Int64): Integer; overload; safecall;

Return the zero-based index of the matching item.

function IndexOf(const aOtherSheet: ISheet; aSkipId: Int64; var aRotated: Boolean): Integer; overload; safecall;

Create a new defect instance.

function CreateDefect(): ISheetDefect; safecall;

Return the item stored under the specified TonCut identifier.

function GetById(aId: Int64): ISheet; safecall;

Calculate max length.

function CalcMaxLength(): Cardinal; safecall;

Start a batched update so change notifications can be delayed.

procedure BeginUpdate(); safecall;

Finish a batched update and allow deferred notifications to resume.

procedure EndUpdate(); safecall;

Report whether the interface is currently inside an update batch.

function IsUpdating(): Boolean; safecall;

Reload the underlying data from the host or storage layer.

procedure Reload(); safecall;

Handle the event callback when the owning event interface invokes it.

procedure Invoke(aSender: IUnknown; aSheet: ISheet; aIndex: Integer); safecall;

Add an item or handler.

procedure Add(aHandler: ISheetChangeEventHandler); safecall;

Remove an item or handler.

procedure Remove(aHandler: ISheetChangeEventHandler); safecall;

Raise the typed change event for the current payload.

procedure Invoke(aSender: IUnknown; aSheet: ISheet; aIndex: Integer); safecall;

X position of the object within solution space.

property PosX: Cardinal read GetPosX write SetPosX;

Y position of the object within solution space.

property PosY: Cardinal read GetPosY write SetPosY;

Length value stored on the object.

property Length: Cardinal read GetLength write SetLength;

Width value stored on the object.

property Width: Cardinal read GetWidth write SetWidth;

Event fired when the object or collection changes.

property OnChange: INotifyEvent read GetOnChange;

Copy values from another object of the same type.

procedure Assign(const aSheetDefect: ISheetDefect); safecall;

Start a batched update so change notifications can be delayed.

procedure BeginUpdate(); safecall;

Finish a batched update and allow deferred notifications to resume.

procedure EndUpdate(); safecall;

Number of items currently exposed by the interface.

property Count: Integer read GetCount;

Indexed property used to read one item from the collection.

property Items[aIndex: Cardinal]: ISheetDefect read GetByIndex; default;

Event fired when an item is added.

property OnAdd: ISheetDefectChangeEvent read GetOnAdd;

Event fired when an item is removed.

property OnRemove: ISheetDefectChangeEvent read GetOnRemove;

Copy values from another object of the same type.

procedure Assign(const aOther: ISheetDefects); safecall;

Remove all items from the collection.

procedure Clear(); safecall;

Add an item or handler.

procedure Add(aSheetDefect: ISheetDefect); safecall;

Delete the item at the specified zero-based index.

procedure DeleteByIndex(aIndex: Cardinal); safecall;

Remove an item or handler.

procedure Remove(const aSheetDefect: ISheetDefect); safecall;

Return the zero-based index of the matching item.

function IndexOf(const aSheetDefect: ISheetDefect): Integer; overload; safecall;

Find an item matching the supplied criteria.

function Find(aPosX: Cardinal; aPosY: Cardinal; aLength: Cardinal; aWidth: Cardinal): ISheetDefect; overload; safecall;

Handle the event callback when the owning event interface invokes it.

procedure Invoke(aSender: IUnknown; aSheetDefect: ISheetDefect; aIndex: Integer); safecall;

Add an item or handler.

procedure Add(aHandler: ISheetDefectChangeEventHandler); safecall;

Remove an item or handler.

procedure Remove(aHandler: ISheetDefectChangeEventHandler); safecall;

Raise the typed change event for the current payload.

procedure Invoke(aSender: IUnknown; aSheetDefect: ISheetDefect; aIndex: Integer); safecall;