HatchPattern

HatchPattern class

Inheritence: Rhino.Runtime.CommonObjectRhino.DocObjects.ModelComponentHatchPattern
Derived Classes:

Namespace: Rhino.DocObjects
HatchPattern: references

Constructors (3)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

HatchPattern()

Properties (36)

ComponentStatus

Gets or sets the component status of the model component.

ComponentType

Returns <b>ModelComponentType.HatchPattern</b> .

ComponentType

Gets the <b>ModelComponentType</b> for this object. Useful in switch statements.

DeletedName

Gets the name of a component that is deleted.

Description

Gets and sets a short description of the pattern.

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

FillType

Gets the pattern's fill type.

HasId

Returns a value indicating whether the component has an ID.

HasIndex

Returns a value indicating whether the component has an Index.

HasName

Returns a value indicating whether the component has a Name.

HasUserData

Gets True if this class has any custom information attached to it through UserData.

HatchLineCount

Get the number of HatchLines in the pattern.

HatchLines

Gets all the hatch lines.

Gets or sets the ID of the current instance.

IdIsLocked

Returns a value indicating whether the component ID is already locked.

Index

Index in the hatch pattern table for this pattern. -1 if not in the table.

Index

Gets or sets the model component index attribute.

IndexIsLocked

Returns a value indicating whether the component Index is already locked.

InstanceDefinitionModelSerialNumber

When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.

IsDeleted

Deleted hatch patterns are kept in the runtime hatch pattern table so that undo will work with hatch patterns. Call IsDeleted to determine to determine if a hatch pattern is deleted.

IsDeleted

True if the component is deleted. Deleted components are kept by the document for undo purposes.

IsDocumentControlled

If True this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.

IsReference

Rhino allows multiple files to be viewed simultaneously. Hatch patterns in the document are "normal" or "reference". Reference hatch patterns are not saved.

IsReference

Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.

IsSystemComponent

True if this model component is a system constant.
An incomplete list of system constant model components is below:
<ul><li>ON_ModelComponent::Unset</li><li>ON_InstanceDefinition::Empty</li><li>ON_Linetype::Unset</li><li>ON_Linetype::Continuous</li><li>ON_Linetype::ByLayer</li><li>ON_Linetype::ByParent</li><li>ON_Layer::Unset</li><li>ON_Layer::Default</li><li>ON_TextStyle::Unset</li><li>ON_TextStyle::Default</li><li>ON_TextStyle::ByLayer</li><li>ON_TextStyle::ByParent</li><li>ON_DimStyle::Unset</li><li>ON_DimStyle::Default</li><li>ON_DimStyle::DefaultInchDecimal</li><li>ON_DimStyle::DefaultInchFractional</li><li>ON_DimStyle::DefaultFootInchArchitecture</li><li>ON_DimStyle::DefaultMillimeterSmall</li><li>ON_DimStyle::DefaultMillimeterLarge</li><li>ON_DimStyle::DefaultMillimeterArchitecture</li></ul>

IsValid

Tests an object to see if it is valid.

ModelSerialNumber

A value identifying the model that manages this component.

Name

Gets or sets the name

NameIsLocked

Returns a value indicating whether the component Name is already locked.

NamePathSeparator

Returns the string "::". This is the string Rhino uses in layer full path names to separate the names of individual layers.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.

UserData

List of custom information that is attached to this class.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

UserStringCount

Gets the amount of user strings.

Methods (37)

AddHatchLine(HatchLine hatchLine)

Add a HatchLine to the pattern.

ClearId()

Resets the HasId property of the model component to false, if possible.

ClearIndex()

Resets the HasIndex property of the model component to false, if possible.

ClearName()

Resets the HasName property of the model component to false, if possible.

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

CreatePreviewGeometry(int width, int height, double angle)

Creates preview line segments of the hatch pattern.

DataCRC(uint currentRemainder)

Increments the Cyclic Redundancy Check value by this instance.

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

For derived class implementers.
This method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.

EnsurePrivateCopy()

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

GetUserString(string key)

Gets user string from this geometry.

GetUserStrings()

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

HatchLineAt(int hatchLineIndex)

Gets a HatchLine at an index.

IsValidComponentName(string name)

Tests for a valid model component name.

IsValidWithLog(out string log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

LockId()

Locks the component Id property.

LockIndex()

Locks the component Index property.

LockName()

Locks the component Name property.

ModelComponentTypeIgnoresCase(ModelComponentType type)

Informs the developer if a particular model component type will require case-ignoring searching within a document. This is currently True with groups; False otherwise.

ModelComponentTypeIncludesParent(ModelComponentType type)

Informs the developer if a particular model component type will include the hash of the parent.

ModelComponentTypeRequiresUniqueName(ModelComponentType type)

Informs the developer if a particular model component type will require uniqueness within a document. This is currently True with render materials and model geometry; False otherwise.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

ReadFromFile(string filename, bool quiet)

Reads hatch pattern definitions from a file.

RemoveAllHatchLines()

Remove all of the hatch line from the pattern.

RemoveHatchLine(int hatchLineIndex)

Remove a hatch line from the pattern.

SetHatchLines(IEnumerable<HatchLine> hatchLines)

Set all of the hatch lines at once. Existing hatch lines are deleted.

SetUserString(string key, string value)

Attach a user string (key,value combination) to this geometry.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

ToString()

Returns the name of the model component type, and then its name and index.

Nothing found