HatchPatternTable

Public Class

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

Inheritance Hierarchy

System.Object
Rhino.FileIO.CommonComponentTable. HatchPattern.
Rhino.DocObjects.Tables.RhinoDocCommonTable. HatchPattern.
Rhino.DocObjects.Tables.HatchPatternTable

Namespace: Rhino.DocObjects.Tables

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class HatchPatternTable : RhinoDocCommonTable<HatchPattern>,
  ICollection<HatchPattern>, IEnumerable<HatchPattern>, IEnumerable

The HatchPatternTable type exposes the following members.

Properties

Name

Description

---

Public Property

ComponentType

(Overrides

CommonComponentTable.T..ComponentType

.)

---

Public Property

Count

Returns the count of all items, including deleted ones.

(Inherited from CommonComponentTable.T..)

---

Public Property
Code Example

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.

---

Public Property

Document

Document that owns this table.

(Inherited from RhinoDocCommonTable.T..)

---

Public Property

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

Name

Description

---

Public Method

Add

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

---

Public Method

Clear

Marks all items as deleted.

(Inherited from CommonComponentTable.T..)

---

Public Method

Delete(HatchPattern)

Deletes a hatch pattern from the table.

(Overrides

CommonComponentTable.T..Delete(T)

.)

---

Public Method

Delete(Int32)

Deletes a hatch pattern from the table.

---

Public Method

Delete(HatchPattern, Boolean)

Deletes a hatch pattern from the table.

---

Public Method

Delete(Int32, Boolean)

Deletes a hatch pattern from the table.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Public Method
Code Example

Find

Obsolete.

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

---

Public Method

FindId

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.

(Inherited from CommonComponentTable.T..)

---

Public Method

FindIndex

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

---

Public Method
Code Example

FindName

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

---

Public Method

FindNameHash

Finds a HatchPattern given its name hash.

---

Public Method

GetEnumerator

Returns the enumerator that yields all items.

(Inherited from CommonComponentTable.T..)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

Modify

Modify hatch pattern settings.

---

Public Method

Rename(HatchPattern, String)

Renames a hatch pattern in the table.

---

Public Method

Rename(Int32, String)

Renames a hatch pattern in the table.

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---