Nothing matches.
Provides a common base for most geometric classes. This class is abstract.
Constructors
Properties
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
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.
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
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.
Overrides: CommonObject.IsDocumentControlled
Is this instance a 'shallow copy'. Shallow copies are no different than regular instances with the exception that they will convert to complete independent 'deep' copies if a non const operation is perform on the instance (something that mutates the internal data)
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
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.
Methods
If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.
Returns: This object's component index. If this object is not a sub-piece of a larger geometric entity, then the returned index has m_type = ComponentIndex.InvalidType and m_index = -1.
ConstructConstObject
Assigns a parent object and a sub-object index to this.
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.
Returns: CRC of the information the defines the object.
public void DeleteAllUserStrings()
Dispose
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
Dispose
#Overridden in order to destroy local display cache information
Overrides: CommonObject.Dispose
Constructs a deep (full) copy of this object.
Returns: An object of the same type as this, with the same properties and behavior.
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.
Returns: An object of the same type as this object.
This behavior is overridden by implementing classes.
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.
public void EnsurePrivateCopy()
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.
Returns: The indication of equality
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.
Returns: True if indeed the objects are really the same. False otherwise.
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
[ConstOperation]
public BoundingBox GetBoundingBox()
accurate
If true, a physically accurate bounding box will be computed. If not, a bounding box estimate will be computed. For some geometry types there is no difference between the estimate and the accurate bounding box. Estimated bounding boxes can be computed much (much) faster than accurate (or "tight") bounding boxes. Estimated bounding boxes are always similar to or larger than accurate bounding boxes.
Returns: The bounding box of the geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
Aligned Bounding box solver. Gets the plane aligned bounding box.
Returns: A BoundingBox in plane coordinates.
Aligned Bounding box solver. Gets the plane aligned bounding box.
Returns: A BoundingBox in plane coordinates.
Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
[ConstOperation]
public virtual BoundingBox GetBoundingBox()
xform
Transformation to apply to object prior to the BoundingBox computation. The geometry itself is not modified.
Returns: The accurate bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
GetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData()
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
Detects overlapping regions among a set of input objects after they are orthogonally projected onto the supplied plane, and reports what should happen to each input object so that the overlaps can be removed.
public static int[] GetOverlaps()
objects,
The geometry to test for overlaps. Supported types are Curve (curves), Point (single points), and PointCloud (sets of points). Objects of any other type, as well as null or invalid objects, are silently ignored.
plane,
The plane the geometry is orthogonally projected onto before testing. Use Plane.WorldXY to test in the world XY plane (dropping Z).
tolerance,
The overlap distance tolerance, measured in the projected plane.
wholeCurves,
When true, an overlapping curve is treated as a single unit; when false, curves may be split at segment boundaries so that only the overlapping portions are affected.
locked,
Geometry that participates in the overlap test but is never itself modified. May be null or empty.
lockedExclusive,
When true, overlaps are only reported where an input object overlaps a locked object; overlaps purely among the input objects are ignored.
entire,
For each returned object index, true if the entire object is an overlap and should be removed. This out parameter is assigned during this call.
deadSegments,
For each returned object index, the component indices of the segments that overlap and should be removed. This out parameter is assigned during this call.
replacements
For each returned object index, an optional replacement curve to use in place of the original, or null when no replacement is produced. This out parameter is assigned during this call.
Returns: The indices, into
objects, of the objects that are affected by an overlap. The entire, deadSegments, and replacements arrays are parallel to the returned array.Exceptions:
| ArgumentNullException | If objects is null. |
Gets user string from this geometry.
Returns: string associated with the key if successful. null if no key was found.
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Returns: true if this object is valid; false otherwise.
If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
Returns: false if object cannot be converted to a deformable object. true if object was already deformable or was converted into a deformable object.
Computes an estimate of the number of bytes that this object is using in memory.
Returns: An estimated memory footprint.
NonConstOperation
#Destroy cache handle
protected override void NonConstOperation()
Overrides: CommonObject.NonConstOperation
OnSwitchToNonConst
#Is called when a non-constant operation occurs.
protected override void OnSwitchToNonConst()
Overrides: CommonObject.OnSwitchToNonConst
Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
Returns: true if geometry successfully rotated.
Scales the object by the specified factor. The scale is centered at the origin.
Returns: true if geometry successfully scaled.
Attach a user string (key,value combination) to this geometry.
Returns: true on success.
ToJSON
Create a JSON string representation of this object
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.
Returns: true if geometry successfully transformed.
Translates the object along the specified vector.
Returns: true if geometry successfully translated.