HatchPatternTable

HatchPatternTable class

All of the hatch pattern definitions contained in a rhino document.

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<HatchPattern>HatchPatternTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
HatchPatternTable: references

Properties (6)

ComponentType

Returns the actual component type of a table.

Count

Returns the count of all items, including deleted ones.

CurrentHatchPatternIndex

At all times, there is a "current" hatch pattern. Unless otherwise specified, new objects are assigned to the current hatch pattern. The current hatch pattern is never locked, hidden, or deleted.

Document

Document that owns this table.

Item

Conceptually, the hatch pattern table is an array of hatch patterns. The operator[] can be used to get individual hatch patterns. A hatch pattern is either active or deleted and this state is reported by HatchPattern.IsDeleted.

Methods (16)

Add(HatchPattern pattern)

Adds a new hatch pattern with specified definition to the table.

Clear()

Marks all items as deleted.

Delete(HatchPattern item, bool quiet)

Deletes a hatch pattern from the table.

Delete(HatchPattern item)

Deletes a hatch pattern from the table.

Delete(int hatchPatternIndex, bool quiet)

Deletes a hatch pattern from the table.

Delete(int hatchPatternIndex)

Deletes a hatch pattern from the table.

Delete(T item)

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

Find(string name, bool ignoreDeleted)

Finds the hatch pattern with a given name. Search ignores case.

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 HatchPattern object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

FindName(string name)

Finds the hatch pattern with a given name. Search ignores case.

FindNameHash(NameHash nameHash)

Finds a HatchPattern given its name hash.

GetEnumerator()

Returns the enumerator that yields all items.

Modify(HatchPattern hatchPattern, int hatchPatternIndex, bool quiet)

Modify hatch pattern settings.

Rename(HatchPattern item, string hatchPatternName)

Renames a hatch pattern in the table.

Rename(int hatchPatternIndex, string hatchPatternName)

Renames a hatch pattern in the table.

Nothing found