CustomMeshObject

CustomMeshObject class

Inheritence: Rhino.Runtime.CommonObjectRhino.DocObjects.ModelComponentRhino.DocObjects.RhinoObjectRhino.DocObjects.MeshObjectCustomMeshObject
Derived Classes:

Namespace: Rhino.DocObjects.Custom
CustomMeshObject: references

Constructors (4)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

CustomMeshObject()

CustomMeshObject(Mesh mesh)

Properties (58)

Attributes

Gets or sets the object attributes.

ComponentStatus

Gets or sets the component status of the model component.

ComponentType

Gets the ModelComponentType for this object. Useful in switch statements.

ComponentType

Returns ModelComponentType.ModelGeometry .

DeletedName

Gets the name of a component that is deleted.

Disposed

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

Document

Gets the document that owns this object.

Geometry

Gets the underlying geometry for this object.
All rhino objects are composed of geometry and attributes.

GripsOn

Gets or sets the activation state of object default editing grips.

GripsSelected

True if grips are turned on and at least one is selected.

GroupCount

Number of groups object belongs to.

HasDynamicTransform

True if the object has a dynamic transformation

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.

HasSubobjectMaterials

Will be True if the object contains sub object meshes with materials that are different than the top level object.

HasUserData

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

Gets or sets the ID of the current instance.

Every object has a Guid (globally unique identifier, also known as UUID, or universally unique identifier). The default value is Guid.Empty.
When an object is added to a model, the value is checked. If the value is Guid.Empty, a new Guid is created. If the value is not None but it is already used by another object in the model, a new Guid is created. If the value is not Guid.Empty and it is not used by another object in the model, then that value persists. When an object is updated, by a move for example, the value of ObjectId persists.
This value is the same as the one returned by this.Attributes.ObjectId.

IdIsLocked

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

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.

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.

IsCustomObject

IsDeletable

Some objects cannot be deleted, like grips on lights and annotation objects.

IsDeleted

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

IsDeleted

True if the object is deleted. Deleted objects are kept by the document for undo purposes. Call RhinoDoc.UndeleteObject to undelete an object.

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.

IsHidden

An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.

IsInstanceDefinitionGeometry

True if the object is used as part of an instance definition.

IsLocked

IsNormal

IsPictureFrame

Returns True if the object is a picture frame. A picture frame object is an object that displays a texture map in all views.

IsReference

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

IsReference

Gets a value indicating if an object is a reference object. An object from a work session reference model is a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.

IsSolid

Returns True if object is a closed solid, otherwise false.

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.

MeshGeometry

ModelSerialNumber

A value identifying the model that manages this component.

Name

Gets or sets the name

Name

Rhino objects have optional text names. More than one object in a model can have the same name and some objects may have no 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.

NextRuntimeSerialNumber

Gets the runtime serial number that will be assigned to the next Rhino Object that is created.

ObjectType

Gets the Rhino-based object type.

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.

ReferenceModelSerialNumber

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

RenderMaterial

Gets the render material associated with this object or None if there is none. This does not pay attention to the material source and will not check parent objects or layers for a RenderMaterial.

RuntimeSerialNumber

Gets the objects runtime serial number.

SubobjectMaterialComponents

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.

Visible

Gets the object visibility.

WorksessionReferenceSerialNumber

Obsolete - use ReferenceModelSerialNumber

Methods (129)

CheckMeshes(IEnumerable<MeshObject> meshObjects,TextLog textLog, ref MeshCheckParameters parameters)

Examines mesh objects and logs a description of what it finds right or wrong. The various properties the function checks for are described in MeshCheckParameters.

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.

CommitChanges()

Moves changes made to this RhinoObject into the RhinoDoc.

ConstructConstObject(object parentObject, int subobjectIndex)

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

CopyHistoryOnReplace()

Gets the setting of the CopyOnReplace field in this object's history

CreateMeshes(MeshType meshType, MeshingParameters parameters, bool ignoreCustomParameters)

Create meshes used to render and analyze surface and polysurface objects.

CustomRenderMeshesBoundingBox(MeshType mt, ViewportInfo vp,Flags flags,PlugIn plugin,DisplayPipelineAttributes attrs, out BoundingBox boundingBox)

Returns the bounding box of custom render primitives for this object .

DataCRC(uint currentRemainder)

Increments the Cyclic Redundancy Check value by this instance.

Description(TextLog textLog)

Get a brief description of a object, including it's attributes and geometry.

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.

DuplicateGeometry()

Constructs a deep (full) copy of the geometry.

DuplicateMeshGeometry()

EnableCustomGrips(CustomObjectGrips customGrips)

Turns on/off the object's editing grips.

EnableVisualAnalysisMode(VisualAnalysisMode mode, bool enable)

Used to turn analysis modes on and off.

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

FromRuntimeSerialNumber(uint serialNumber)

Get a Rhino object for a unique runtime serial number

GetActiveVisualAnalysisModes()

Gets a list of currently enabled analysis modes for this object.

GetBoundingBox(RhinoViewport viewport)

Called when Rhino wants the bounding box of this object. Viewpoert can be null. This is the default base class version that will go through to the C++ base class if it is called from the custom object

GetCustomRenderMeshParameter(Guid providerId,String parameterName)

Query the object for the value of a given named custom render mesh parameter.

GetDynamicTransform(out Transform transform)

While an object is being dynamically transformed (dragged, rotated, ...), the current transformation can be retrieved and used for creating dynamic display.

GetFillSurfaces(RhinoObject rhinoObject, ClippingPlaneObject clippingPlaneObject)

Return list of fill surfaces if any for object and clipping plane.

GetFillSurfaces(RhinoObject rhinoObject, IEnumerable<ClippingPlaneObject> clippingPlaneObjects, bool unclippedFills)

Return list of fill surfaces if any for object and clipping plane.

GetFillSurfaces(RhinoObject rhinoObject, IEnumerable<ClippingPlaneObject> clippingPlaneObjects)

Return list of fill surfaces if any for object and clipping plane. Fills are trimmed by clipping planes that did not generate them.

GetGrips()

Returns grips for this object If grips are enabled. If grips are not enabled, returns null.

GetGroupList()

Allocates an array of group indices of length GroupCount. If GroupCount is 0, then this method returns null.

GetHighlightedSubObjects()

Gets a list of all highlighted sub-objects.

GetMaterial(bool frontMaterial)

Gets material that this object uses based on it's attributes and the document that the object is associated with. In the rare case that a document is not associated with this object, None will be returned.

GetMaterial(ComponentIndex componentIndex,Guid plugInId, ObjectAttributes attributes)

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

GetMaterial(ComponentIndex componentIndex,Guid plugInId)

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

GetMaterial(ComponentIndex componentIndex)

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

GetMeshes(MeshType meshType)

Get existing meshes used to render and analyze surface and polysurface objects.

GetObjectData(SerializationInfo info,StreamingContext context)

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

GetRenderMaterial(bool frontMaterial)

Gets the RenderMaterial that this object uses based on it's attributes and the document that the object is associated with. If there is no RenderMaterial associated with this object then None is returned. If None is returned you should call GetMaterial to get the material used to render this object.

GetRenderMaterial(ComponentIndex componentIndex,Guid plugInId, ObjectAttributes attributes)

Gets the RenderMaterial associated with this object if there is one. If there is no RenderMaterial associated with this object then None is returned. If None is returned you should call GetMaterial to get the material used to render this object.

GetRenderMaterial(ComponentIndex componentIndex,Guid plugInId)

GetRenderMaterial(ComponentIndex componentIndex)

GetRenderMeshes(IEnumerable<RhinoObject> rhinoObjects, bool okToCreate, bool returnAllObjects)

Gets the render meshes of some objects.

GetRenderMeshesWithUpdatedTCs(IEnumerable<RhinoObject> rhinoObjects, bool okToCreate, bool returnAllObjects, bool skipHiddenObjects, bool updateMeshTCs)

Gets the render meshes of some objects.

GetRenderMeshParameters()

Returns the meshing parameters that this object uses for generating render meshes. If this object does not have per-object meshing parameters, then the document's meshing parameters are returned.

GetRenderMeshParameters(bool returnDocumentParametersIfUnset)

Returns the meshing parameters that this object uses for generating render meshes.

GetRenderPrimitiveList(ViewportInfo viewport, bool preview)

Build custom render mesh(es) for this object.

GetRenderPrimitiveList(ViewportInfo viewport,DisplayPipelineAttributes attrs)

Build custom render mesh(es) for this object.

GetSelectedSubObjects()

Get a list of all selected sub-objects.

GetSubObjects()

Explodes the object into sub-objects. It is up to the caller to add the returned objects to the document.

GetTextureChannels()

Get a list of the texture mapping channel Id's associated with object.

GetTextureMapping(int channel, out Transform objectTransform)

Get objects texture mapping

GetTextureMapping(int channel)

GetTightBoundingBox(IEnumerable<RhinoObject> rhinoObjects, out BoundingBox boundingBox)

Gets a world XY-plane aligned tight bounding box from a collection of Rhino objects.

GetTightBoundingBox(IEnumerable<RhinoObject> rhinoObjects, Plane plane, out BoundingBox boundingBox)

Gets a plane aligned tight bounding box from a collection of Rhino objects.

GetTightBoundingBox(ref BoundingBox tightBox, bool growBox, Transform xform)

Get tight bounding box of this Rhino object. The Rhino object is not modified.

HasCustomRenderMeshes(MeshType mt, ViewportInfo vp,Flags flags,PlugIn plugin,DisplayPipelineAttributes attrs)

Returns True if the object will has a set of custom render primitives - ie, CustomRenderMeshes will return non-null.

HasHistoryRecord()

Returns whether this object has a history record

HasTextureMapping()

Returns True if this object has a texture mapping form any source (pluginId)

Highlight(bool enable)

Modifies the highlighting of the object.

HighlightSubObject(ComponentIndex componentIndex, bool highlight)

Highlights a sub-object.

HistoryChildren()

Gets the ids of the child Rhino objects of this object.

HistoryParents()

Gets the ids of the parent Rhino objects of this object.

InVisualAnalysisMode()

Reports if any visual analysis mode is currently active for an object.

InVisualAnalysisMode(VisualAnalysisMode mode)

Reports if a visual analysis mode is currently active for an object.

IsActiveInViewport(RhinoViewport viewport)

Determine if this object is active in a particular viewport.

IsHighlighted(bool checkSubObjects)

Check highlight state.

IsMeshable(MeshType meshType)

Returns True if the object is capable of having a mesh of the specified type

IsSelectable()

Reports if an object can be selected.

IsSelectable(bool ignoreSelectionState, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)

Reports if an object can be selected.

IsSelected(bool checkSubObjects)

Check selection state.

IsSubObjectHighlighted(ComponentIndex componentIndex)

Determines if a sub-object is highlighted.

IsSubObjectSelectable(ComponentIndex componentIndex, bool ignoreSelectionState)

Reports if a sub-object can be selected.

IsSubObjectSelected(ComponentIndex componentIndex)

Check sub-object selection state.

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.

MemoryEstimate()

Computes an estimate of the number of bytes that this object is using in memory. Note that this is a runtime memory estimate and does not directly compare to the amount of space take up by the object when saved to a file.

MeshCount(MeshType meshType, MeshingParameters parameters)

RhinoObjects can have several different types of meshes and different numbers of meshes. A b-rep can have a render and an analysis mesh on each face. A mesh object has a single render mesh and no analysis mesh. Curve, point, and annotation objects have no meshes.

MeshObjects(IEnumerable<RhinoObject> rhinoObjects, MeshingParameters parameters, out Mesh[] meshes, out ObjectAttributes[] attributes, bool useWorkerThread)

Meshes Rhino objects.

MeshObjects(IEnumerable<RhinoObject> rhinoObjects, MeshingParameters parameters, out Mesh[] meshes, out ObjectAttributes[] attributes)

Meshes Rhino objects.

MeshObjects(IEnumerable<RhinoObject> rhinoObjects, ref MeshingParameters parameters, ref bool simpleDialog, out Mesh[] meshes, out ObjectAttributes[] attributes)

Meshes Rhino objects.

MeshObjects(IEnumerable<RhinoObject> rhinoObjects, ref MeshingParameters parameters, ref int uiStyle, Transform xform, out Mesh[] meshes, out ObjectAttributes[] attributes)

Meshes Rhino objects.

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.

ObjectFrame()

ObjectFrame(ObjectFrameFlags flags)

OnAddToDocument(RhinoDoc doc)

This call informs an object it is about to be added to the list of active objects in the document.

OnDeleteFromDocument(RhinoDoc doc)

This call informs an object it is about to be deleted. Some objects, like clipping planes, need to do a little extra cleanup before they are deleted.

OnDraw(DrawEventArgs e)

Called when Rhino wants to draw this object

OnDuplicate(RhinoObject source)

Called when this a new instance of this object is created and copied from an existing object

OnPick(PickContext context)

Called to determine if this object or some sub-portion of this object should be picked given a pick context.

OnPicked(PickContext context, IEnumerable<ObjRef> pickedItems)

Called when this object has been picked

OnSelectionChanged()

Called when the selection state of this object has changed

OnSpaceMorph(SpaceMorph morph)

Called when a space morph has been applied to the geometry. Currently this only works for CustomMeshObject instances

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

OnTransform(Transform transform)

Called when a transformation has been applied to the geometry

RenderMeshes(MeshType mt, ViewportInfo vp, List<InstanceObject> ancestry,Flags flags,PlugIn plugin,DisplayPipelineAttributes attrs)

Returns a set of custom render primitives for this object.

Select(bool on, bool syncHighlight, bool persistentSelect, bool ignoreGripsState, bool ignoreLayerLocking, bool ignoreLayerVisibility)

Selects an object.

Select(bool on, bool syncHighlight)

Selects an object.

Select(bool on)

Selects an object.

SelectSubObject(ComponentIndex componentIndex, bool select, bool syncHighlight, bool persistentSelect)

Reports if an object can be selected.

SelectSubObject(ComponentIndex componentIndex, bool select, bool syncHighlight)

Reports if an object can be selected.

SetCopyHistoryOnReplace(bool bCopy)

If this object has a history record, the CopyOnReplace field is set When an object is replaced in a document and the old object has a history record with this field set, the history record is copied and attached to the new object. That allows a descendant object to continue the history linkage after it is edited.

SetCustomRenderMeshParameter(Guid providerId,String parameterName, object value)

Set the named custom render mesh parameter value for this object.

SetHistory(HistoryRecord history)

For expert use only. Sets the history record that describes how this object was created. This information is used to update this object when Rhino history is enabled and an input object changes.

SetMesh(Mesh mesh)

Only for developers who are defining custom subclasses of MeshObject. Directly sets the internal mesh geometry for this object. Note that this function does not work with Rhino's "undo".

SetObjectFrame(Plane plane)

SetObjectFrame(Transform xform)

SetRenderMeshParameters(MeshingParameters mp)

Sets the per-object meshing parameters for this object. When set, this object will use these meshing parameters when generating a render mesh, instead of those provided by the document.

SetTextureMapping(int channel, TextureMapping tm, Transform objectTransform)

Sets texture mapping and mapping object transform for a channel

SetTextureMapping(int channel, TextureMapping tm)

ShortDescription(bool plural)

Gets a localized short descriptive name of the object.

ShortDescriptionWithClosedStatus(bool prepend, bool plural, out int status)

Gets a localized short descriptive name of the object, along with it's open/closed status.

SupportsRenderPrimitiveList(ViewportInfo viewport, bool preview)

Determines if custom render meshes will be built for a particular object.

SupportsRenderPrimitiveList(ViewportInfo viewport,DisplayPipelineAttributes attrs)

Determines if custom render meshes will be built for a particular object.

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.

TryGetGumballFrame(out GumballFrame frame)

If a Rhino object has been manipulated by Rhino's gumball, and the gumball is not in its default position, then the object's repositioned gumball frame is returned.

TryGetRenderPrimitiveBoundingBox(ViewportInfo viewport, bool preview, out BoundingBox boundingBox)

Get the bounding box for the custom render meshes associated with this object.

TryGetRenderPrimitiveBoundingBox(ViewportInfo viewport,DisplayPipelineAttributes attrs, out BoundingBox boundingBox)

Get the bounding box for the custom render meshes associated with this object.

UnhighlightAllSubObjects()

Removes highlighting from all sub-objects.

UnselectAllSubObjects()

Removes selection from all sub-objects.

Nothing found