Bands

Persistent numeric identifier used by TonCut to track the object.

property Id: Int64 read GetId write SetId;

Human-readable title shown to users.

property Title: WideString read GetTitle write SetTitle;

Width value stored on the object.

property Width: Cardinal read GetWidth write SetWidth;

Gets or sets max material thickness.

property MaxMaterialThickness: Cardinal read GetMaxMaterialThickness write SetMaxMaterialThickness;

Thickness value stored on the object.

property Thickness: Cardinal read GetThickness write SetThickness;

Surplus allowance stored on the object.

property Surplus: Cardinal read GetSurplus write SetSurplus;

Gets or sets the color used when this band is drawn in a preview, as a TTcColor: a 24-bit RGB value packed as $RRGGBB (not the VCL TColor byte order), clTcNone (-1, no preview color; the default) or clTcRandom (-2, the host derives a stable color from the item’s Id). GetPreviewColor/SetPreviewColor are vtable slots appended at the end of the interface, after EndUpdate, under the same interface GUID, so no existing slot moves; every implementer must add both methods. Engine version 24 carries these slots.

property PreviewColor: TTcColor read GetPreviewColor write SetPreviewColor;

Event fired when the object or collection changes.

property OnChange: INotifyEvent read GetOnChange;

Event fired when an identifier changes.

property OnIdChange: IIdChangeEvent read GetOnIdChange;

Create a copy of the current object.

function Clone(): IBand; safecall;

Copy values from another object of the same type.

procedure Assign(const aOther: IBand); 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;

Signed value assigned to the north or top edge; a negative edge-distance value means inherited or unspecified.

property North: IBand read GetNorth write SetNorth;

Signed value assigned to the south or bottom edge; a negative edge-distance value means inherited or unspecified.

property South: IBand read GetSouth write SetSouth;

Signed value assigned to the west or left edge; a negative edge-distance value means inherited or unspecified.

property West: IBand read GetWest write SetWest;

Signed value assigned to the east or right edge; a negative edge-distance value means inherited or unspecified.

property East: IBand read GetEast write SetEast;

Alias of North; a negative edge-distance value means inherited or unspecified.

property Top: IBand read GetNorth write SetNorth;

Alias of South; a negative edge-distance value means inherited or unspecified.

property Bottom: IBand read GetSouth write SetSouth;

Alias of West; a negative edge-distance value means inherited or unspecified.

property Left: IBand read GetWest write SetWest;

Alias of East; a negative edge-distance value means inherited or unspecified.

property Right: IBand read GetEast write SetEast;

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 aOther: IBanding); 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]: IBand read GetByIndex; default;

Add an item or handler.

procedure Add(aBand: IBand); safecall;

Delete the item at the specified zero-based index.

procedure DeleteByIndex(aIndex: Cardinal); safecall;

Remove an item or handler.

procedure Remove(const aBand: IBand); safecall;

Return the zero-based index of the matching item.

function IndexOf(const aBand: IBand): Integer; overload; 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]: IBand read GetByIndex; default;

Event fired when an item is added.

property OnAdd: IBandChangeEvent read GetOnAdd;

Event fired when an item is removed.

property OnRemove: IBandChangeEvent read GetOnRemove;

Open the Desktop band dialog for a new band. The user can review and update the details before confirming; if the dialog is cancelled, the method returns null.

function CreateBand(): IBand; safecall;

Add an item or handler.

procedure Add(aBand: IBand); 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 aBand: IBand); safecall;

Return the zero-based index of the matching item.

function IndexOf(const aBand: IBand): Integer; overload; safecall;

Return the zero-based index of the matching item.

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

Search for an existing item that duplicates the supplied object.

function FindDuplicate(const aBand: IBand; aCheckTitle: Boolean = False): IBand; safecall;

Find an item by its title and any additional matching fields.

function FindByTitle(const aTitle: WideString; aWidth: Cardinal; aThickness: Cardinal): IBand; safecall;

Generate or return a title that is unique within the collection.

function FindUniqueName(const aBaseName: WideString; aWidth: Cardinal; aThickness: Cardinal): WideString; safecall;

Check whether a proposed title is unique within the collection.

function CheckUniqueName(const aTitle: WideString; aWidth: Cardinal; aThickness: Cardinal; const aIgnoreBand: IBand): Boolean; overload; safecall;

Check whether a proposed title is unique within the collection.

function CheckUniqueName(aBand: IBand; aAutoFix: Boolean = False): Boolean; overload; safecall;

Return the item stored under the specified TonCut identifier.

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

Record a band as recently used for the selected material.

procedure AddMaterialBandToHistory(aMaterial: IMaterial; aBand: IBand); safecall;

Load recently used bands for the selected material.

function LoadMaterialBandsFromHistory(aMaterial: IMaterial; aLimit: Integer = 5): IBandList; safecall;

Load bands applicable to the selected material.

function LoadMaterialBands(aMaterial: IMaterial): IBandList; 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; aBand: IBand; aIndex: Integer); safecall;

Add an item or handler.

procedure Add(aHandler: IBandChangeEventHandler); safecall;

Remove an item or handler.

procedure Remove(aHandler: IBandChangeEventHandler); safecall;

Raise the typed change event for the current payload.

procedure Invoke(aSender: IUnknown; aBand: IBand; aIndex: Integer); safecall;