RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.DocObjects.Tables

/

BitmapTable

BitmapTable class

Stores the list of bitmaps in a Rhino document.

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<BitmapEntry>BitmapTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
BitmapTable: references

Properties (5)

ComponentType

Returns <b>ModelComponentType.Image</b> .

ComponentType

Returns the actual component type of a table.

Count

Returns the count of all items, including deleted ones.

Document

Document that owns this table.

Item

Conceptually, the bitmap table is an array of bitmaps. The operator[] can be used to get individual bitmaps.

Methods (11)

AddBitmap(string bitmapFilename, bool replaceExisting)

Adds a new bitmap with specified name to the bitmap table.

Clear()

Marks all items as deleted.

Delete(BitmapEntry item)

Removes the bitmap from the table.

Delete(T item)

Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.

DeleteBitmap(string bitmapFilename)

Deletes a bitmap.

ExportToFile(int index, string path)

Writes a bitmap to a file.

ExportToFiles(string directoryPath, int overwrite)

Exports all the bitmaps in the table to files.

Find(string name, bool createFile, out string fileName)

This function first attempts to find the file with "name" on the disk. If it does find it, "fileName" is set to the full path of the file and the BitmapEntry returned will be null, even if there was a BitmapEntry with "name" in the bitmap table. If the function cannot find the file on the disk, it searches the bitmap table. If it finds it, the returned BitmapEntry entry will be the entry in the table with that name. Additionally, if "createFile" is true, and an entry is found, the file will be written to the disk and it's full path will be contained in "fileName".

FindId(Guid id)

Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.

FindIndex(int index)

Retrieves a BitmapEntry object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

GetEnumerator()

Returns the enumerator that yields all items.

Nothing found