Hatch

Hatch class

Represents a hatch in planar boundary loop or loops. This is a 2d entity with a plane defining a local coordinate system. The loops, patterns, angles, etc are all in this local coordinate system. The Hatch object manages the plane and loop array Fill definitions are in the HatchPattern or class derived from HatchPattern Hatch has an index to get the pattern definition from the pattern table.

inheritence: Rhino.Runtime.CommonObjectRhino.Geometry.GeometryBaseHatch

Namespace: Rhino.Geometry
Hatch: references

Constructors (4)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

GeometryBase(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Hatch(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Properties (17)

BasePoint

Gets or sets the hatch pattern base point

Disposed

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

HasBrepForm

Returns True if the Brep.TryConvertBrep function will be successful for this object

HasUserData

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

IsDeformable

True if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.

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.

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.

IsValid

Tests an object to see if it is valid.

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

PatternIndex

Gets or sets the index of the pattern in the document hatch pattern table.

PatternRotation

Gets or sets the relative rotation of the pattern.

PatternScale

Gets or sets the scaling factor of the pattern.

PerformCorruptionTesting

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

Plane

Gets or sets the hatch plane

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 (47)

ComponentIndex()

If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.

ConstructConstObject(Object parentObject,Int32 subobjectIndex)

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

Create(Curve curve,Int32 hatchPatternIndex,Double rotationRadians,Double scale,Double tolerance)

Constructs an array of Hatch from one curve.

Create(Curve curve,Int32 hatchPatternIndex,Double rotationRadians,Double scale)

Constructs an array of Hatch from one curve.

Create(IEnumerable<Curve> curves,Int32 hatchPatternIndex,Double rotationRadians,Double scale,Double tolerance)

Constructs an array of Hatch from a set of curves.

Create(IEnumerable<Curve> curves,Int32 hatchPatternIndex,Double rotationRadians,Double scale)

Constructs an array of Hatch from a set of curves.

Create(Plane hatchPlane, Curve outerLoop, IEnumerable<Curve> innerLoops,Int32 hatchPatternIndex,Double rotationRadians,Double scale)

Create a hatch with a given set of outer and inner loops

CreateDisplayGeometry(HatchPattern pattern,Double patternScale, out Curve[] bounds, out Line[] lines, out Brep solidBrep)

Generate geometry that would be used to draw the hatch with a given hatch pattern

CreateFromBrep(Brep brep,Int32 brepFaceIndex,Int32 hatchPatternIndex,Double rotationRadians,Double scale, Point3d basePoint)

Create a hatch from a planar face of a Brep

DataCRC(UInt32 currentRemainder)

Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(Boolean 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.

Dispose(Boolean disposing)

Overridden in order to destroy local display cache information

Duplicate()

Constructs a deep (full) copy of this object.

DuplicateShallow()

Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy.

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.

Explode()

Decomposes the hatch pattern into an array of geometry.

FromBase64String(Int32 archive3dm,Int32 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

GeometryEquals(GeometryBase first, GeometryBase second)

Determines if two geometries equal one another, in pure geometrical shape. This version only compares the geometry itself and does not include any user data comparisons. This is a comparison by value: for two identical items it will be true, no matter where in memory they may be stored.

GeometryReferenceEquals(GeometryBase one, GeometryBase other)

Determines if two objects are respectively shallow copies, new managed instantiations of the same geometry, or similar internal references to the exact same geometry, both in managed and in unmanaged code.

Get3dCurves(Boolean outer)

Gets 3d curves that define the boundaries of the hatch

GetBoundingBox(Plane plane, out Box worldBox)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Plane plane)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Boolean accurate)

Bounding box solver. Gets the world axis aligned bounding box for the geometry.

GetBoundingBox(Transform xform)

Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

GetGradientFill()

Get gradient fill information for this hatch. If the "GradientType" for the fill is None, then this hatch doesn't have any gradient fill.

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.

IsValidWithLog(String log)

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

MakeDeformable()

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.

MemoryEstimate()

Computes an estimate of the number of bytes that this object is using in memory.

NonConstOperation()

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

NonConstOperation()

Destroy cache handle

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

OnSwitchToNonConst()

Is called when a non-constant operation occurs.

Rotate(Double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

Scale(Double scaleFactor)

Scales the object by the specified factor. The scale is centered at the origin.

ScalePattern(Transform xform)

Scale the hatch's pattern

SetGradientFill(ColorGradient fill)

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

Transform(Transform xform)

Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it.

Translate(Double x,Double y,Double z)

Translates the object along the specified vector.

Translate(Vector3d translationVector)

Translates the object along the specified vector.

Nothing found