Click or drag to resize

BitmapTable Class

Stores the list of bitmaps in a Rhino document.
Inheritance Hierarchy
SystemObject
  Rhino.DocObjects.TablesBitmapTable

Namespace:  Rhino.DocObjects.Tables
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public sealed class BitmapTable : IEnumerable<BitmapEntry>, 
	IEnumerable

The BitmapTable type exposes the following members.

Properties
  NameDescription
Public propertyComponentType
Returns Image.
(Overrides CommonComponentTableTComponentType.)
Public propertyCount
Gets the number of bitmaps in the table.


In Rhino for Windows 6.6, this member is inherited from CommonComponentTableTCount.
Public propertyDocument
Gets the document that owns this bitmap table.


In Rhino for Windows 6.6, this member is inherited from RhinoDocCommonTableTDocument.
Public propertyItem
Conceptually, the bitmap table is an array of bitmaps. The operator[] can be used to get individual bitmaps.
Top
Methods
  NameDescription
Public methodAddBitmap
Adds a new bitmap with specified name to the bitmap table.
Public methodClear
Marks all items as deleted.
(Inherited from CommonComponentTableT.)
Public methodDelete
Removes the bitmap from the table.
(Overrides CommonComponentTableTDelete(T).)
Public methodDeleteBitmap
Deletes a bitmap.
Public methodEquals (Inherited from Object.)
Public methodExportToFile
Writes a bitmap to a file.
Public methodExportToFiles
Exports all the bitmaps in the table to files.
Public methodFind
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".
Public methodFindId
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/openning operations. This function will not find grip objects.
(Inherited from CommonComponentTableT.)
Public methodFindIndex
Retrieves a BitmapEntry object based on Index. This seach type of search is discouraged. We are moving towards using only IDs for all tables.
Public methodGetEnumerator
BitmapTable enumerator


In Rhino for Windows 6.6, this member is inherited from CommonComponentTableTGetEnumerator.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.6
See Also