MeshObject Class |
[Missing <summary> documentation for "T:Rhino.DocObjects.MeshObject"]
Namespace: Rhino.DocObjects
The MeshObject type exposes the following members.
Name | Description | |
---|---|---|
Attributes |
Gets or sets the object attributes.
(Inherited from RhinoObject.) | |
ComponentStatus |
Gets or sets the component status of the model component.
(Inherited from ModelComponent.) | |
ComponentType |
Returns ModelGeometry.
(Inherited from RhinoObject.) | |
DeletedName |
Gets the name of a component that is deleted.
(Inherited from ModelComponent.) | |
Disposed |
Indicates if this object has been disposed or the
document it originally belonged to has been disposed.
(Inherited from CommonObject.) | |
Document |
Gets the document that owns this object.
(Inherited from RhinoObject.) | |
Geometry |
Gets the underlying geometry for this object.
(Inherited from RhinoObject.)All rhino objects are composed of geometry and attributes. | |
GripsOn | Gets or sets the activation state of object default editing grips. (Inherited from RhinoObject.) | |
GripsSelected |
true if grips are turned on and at least one is selected.
(Inherited from RhinoObject.) | |
GroupCount | Number of groups object belongs to. (Inherited from RhinoObject.) | |
HasDynamicTransform |
True if the object has a dynamic transformation
(Inherited from RhinoObject.) | |
HasId |
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.) | |
HasIndex |
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.) | |
HasName |
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.) | |
HasSubobjectMaterials |
Will be true if the object contains sub object meshes with materials
that are different than the top level object.
(Inherited from RhinoObject.) | |
HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) | |
Id |
Every object has a Guid (globally unique identifier, also known as UUID, or universally
unique identifier). The default value is Guid.Empty.
(Inherited from RhinoObject.)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 null 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.
(Inherited from ModelComponent.) | |
Index |
Gets or sets the model component index attribute.
(Inherited from ModelComponent.) | |
IndexIsLocked |
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.) | |
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.
(Inherited from RhinoObject.) | |
IsComponentStatusLocked |
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.) | |
IsCustomObject | ||
IsDeletable |
Some objects cannot be deleted, like grips on lights and annotation objects.
(Inherited from RhinoObject.) | |
IsDeleted |
true if the object is deleted. Deleted objects are kept by the document
for undo purposes. Call RhinoDoc.UndeleteObject to undelete an object.
(Inherited from RhinoObject.) | |
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.
(Inherited from CommonObject.) | |
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.
(Inherited from RhinoObject.) | |
IsInstanceDefinitionGeometry |
true if the object is used as part of an instance definition.
(Inherited from RhinoObject.) | |
IsLocked |
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.
(Inherited from RhinoObject.) | |
IsNormal |
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.
(Inherited from RhinoObject.) | |
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.
(Inherited from RhinoObject.) | |
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.
(Inherited from RhinoObject.) | |
IsSolid |
Returns true if object is a closed solid, otherwise false.
(Inherited from RhinoObject.) | |
IsSystemComponent |
True if this model component is a system constant.
(Inherited from ModelComponent.)An incomplete list of system constant model components is below:
| |
IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) | |
MeshGeometry | ||
ModelSerialNumber |
A value identifying the model that manages this component.
(Inherited from ModelComponent.) | |
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.
(Inherited from RhinoObject.) | |
NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) | |
ObjectType |
Gets the Rhino-based object type.
(Inherited from RhinoObject.) | |
ReferenceModelSerialNumber |
When a component is in a model for reference, this value identifies the reference model.
(Inherited from RhinoObject.) | |
RenderMaterial |
Gets the render material associated with this object or null if there
is none. This does not pay attention to the material source and will
not check parent objects or layers for a RenderMaterial.
(Inherited from RhinoObject.) | |
RuntimeSerialNumber |
Gets the objects runtime serial number.
(Inherited from RhinoObject.) | |
SubobjectMaterialComponents | (Inherited from RhinoObject.) | |
UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) | |
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.
(Inherited from CommonObject.) | |
Visible | Gets the object visibility. (Inherited from RhinoObject.) |
Name | Description | |
---|---|---|
CheckMeshes |
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.
(Inherited from ModelComponent.) | |
ClearIndex |
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.) | |
ClearName |
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.) | |
CommitChanges |
Moves changes made to this RhinoObject into the RhinoDoc.
(Inherited from RhinoObject.) | |
ConstructConstObject |
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.) | |
CopyHistoryOnReplace |
Gets the setting of the CopyOnReplace field in this object's history
(Inherited from RhinoObject.) | |
CreateMeshes |
Create meshes used to render and analyze surface and polysurface objects.
(Inherited from RhinoObject.) | |
CustomRenderMeshesBoundingBox |
Returns the bounding box of custom render primitives for this object .
(Inherited from RhinoObject.) | |
DataCRC |
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.) | |
Description |
Get a brief description of a object, including it's attributes and geometry.
(Inherited from RhinoObject.) | |
Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) | |
Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)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.
(Inherited from RhinoObject.) | |
DuplicateMeshGeometry | ||
EnableCustomGrips | Turns on/off the object's editing grips. (Inherited from RhinoObject.) | |
EnableVisualAnalysisMode |
Used to turn analysis modes on and off.
(Inherited from RhinoObject.) | |
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.
(Inherited from CommonObject.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) | |
GetActiveVisualAnalysisModes |
Gets a list of currently enabled analysis modes for this object.
(Inherited from RhinoObject.) | |
GetBoundingBox |
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
(Inherited from RhinoObject.) | |
GetCustomRenderMeshParameter |
Query the object for the value of a given named custom render mesh parameter.
(Inherited from RhinoObject.) | |
GetDynamicTransform |
While an object is being dynamically transformed (dragged, rotated, ...),
the current transformation can be retrieved and used for creating
dynamic display.
(Inherited from RhinoObject.) | |
GetGrips |
Returns grips for this object If grips are enabled. If grips are not
enabled, returns null.
(Inherited from RhinoObject.) | |
GetGroupList |
Allocates an array of group indices of length GroupCount.
If GroupCount is 0, then this method returns null.
(Inherited from RhinoObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetHighlightedSubObjects |
Gets a list of all highlighted sub-objects.
(Inherited from RhinoObject.) | |
GetMaterial(Boolean) |
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, null will be returned.
(Inherited from RhinoObject.) | |
GetMaterial(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.
(Inherited from RhinoObject.) | |
GetMaterial(ComponentIndex, Guid) |
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.
(Inherited from RhinoObject.) | |
GetMaterial(ComponentIndex, Guid, ObjectAttributes) |
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.
(Inherited from RhinoObject.) | |
GetMeshes |
Get existing meshes used to render and analyze surface and polysurface objects.
(Inherited from RhinoObject.) | |
GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) | |
GetRenderMaterial(Boolean) |
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 null is returned. If
null is returned you should call GetMaterial to get the material used
to render this object.
(Inherited from RhinoObject.) | |
GetRenderMaterial(ComponentIndex) |
Gets the RenderMaterial associated with this object if there is one. If
there is no RenderMaterial associated with this object then null is
returned. If null is returned you should call GetMaterial to get the
material used to render this object.
(Inherited from RhinoObject.) | |
GetRenderMaterial(ComponentIndex, Guid) |
Gets the RenderMaterial associated with this object if there is one. If
there is no RenderMaterial associated with this object then null is
returned. If null is returned you should call GetMaterial to get the
material used to render this object.
(Inherited from RhinoObject.) | |
GetRenderMaterial(ComponentIndex, Guid, ObjectAttributes) |
Gets the RenderMaterial associated with this object if there is one. If
there is no RenderMaterial associated with this object then null is
returned. If null is returned you should call GetMaterial to get the
material used to render this object.
(Inherited from RhinoObject.) | |
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.
(Inherited from RhinoObject.) | |
GetRenderMeshParameters(Boolean) |
Returns the meshing parameters that this object uses for generating render meshes.
(Inherited from RhinoObject.) | |
GetRenderPrimitiveList(ViewportInfo, DisplayPipelineAttributes) | Obsolete.
Build custom render mesh(es) for this object.
(Inherited from RhinoObject.) | |
GetRenderPrimitiveList(ViewportInfo, Boolean) | Obsolete.
Build custom render mesh(es) for this object.
(Inherited from RhinoObject.) | |
GetSelectedSubObjects | Get a list of all selected sub-objects. (Inherited from RhinoObject.) | |
GetSubObjects |
Explodes the object into sub-objects. It is up to the caller to add the returned objects to the document.
(Inherited from RhinoObject.) | |
GetTextureChannels |
Get a list of the texture mapping channel Id's associated with object.
(Inherited from RhinoObject.) | |
GetTextureMapping(Int32) | (Inherited from RhinoObject.) | |
GetTextureMapping(Int32, Transform) |
Get objects texture mapping
(Inherited from RhinoObject.) | |
GetTightBoundingBox(BoundingBox, Boolean, Transform) |
Get tight bounding box of this Rhino object. The Rhino object is not modified.
(Inherited from RhinoObject.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HasCustomRenderMeshes |
Returns true if the object will has a set of custom render primitives - ie, CustomRenderMeshes will return non-null.
(Inherited from RhinoObject.) | |
HasHistoryRecord |
Returns whether this object has a history record
(Inherited from RhinoObject.) | |
HasTextureMapping |
Returns true if this object has a texture mapping form any source (pluginId)
(Inherited from RhinoObject.) | |
Highlight |
Modifies the highlighting of the object.
(Inherited from RhinoObject.) | |
HighlightSubObject |
Highlights a sub-object.
(Inherited from RhinoObject.) | |
InVisualAnalysisMode |
Reports if any visual analysis mode is currently active for an object.
(Inherited from RhinoObject.) | |
InVisualAnalysisMode(VisualAnalysisMode) |
Reports if a visual analysis mode is currently active for an object.
(Inherited from RhinoObject.) | |
IsActiveInViewport |
Determine if this object is active in a particular viewport.
(Inherited from RhinoObject.) | |
IsHighlighted | Check highlight state. (Inherited from RhinoObject.) | |
IsMeshable |
Returns true if the object is capable of having a mesh of the specified type
(Inherited from RhinoObject.) | |
IsSelectable | Reports if an object can be selected. (Inherited from RhinoObject.) | |
IsSelectable(Boolean, Boolean, Boolean, Boolean) | Reports if an object can be selected. (Inherited from RhinoObject.) | |
IsSelected | Check selection state. (Inherited from RhinoObject.) | |
IsSubObjectHighlighted |
Determines if a sub-object is highlighted.
(Inherited from RhinoObject.) | |
IsSubObjectSelectable | Reports if a sub-object can be selected. (Inherited from RhinoObject.) | |
IsSubObjectSelected | Check sub-object selection state. (Inherited from RhinoObject.) | |
IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) | |
LockId |
Locks the component Id property.
(Inherited from ModelComponent.) | |
LockIndex |
Locks the component Index property.
(Inherited from ModelComponent.) | |
LockName |
Locks the component Name property.
(Inherited from ModelComponent.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.
(Inherited from RhinoObject.) | |
MeshCount |
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.
(Inherited from RhinoObject.) | |
NonConstOperation |
For derived classes implementers.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being constant. | |
ObjectFrame | (Inherited from RhinoObject.) | |
ObjectFrame(RhinoObjectObjectFrameFlags) | (Inherited from RhinoObject.) | |
OnAddToDocument |
This call informs an object it is about to be added to the list of
active objects in the document.
(Inherited from RhinoObject.) | |
OnDeleteFromDocument |
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.
(Inherited from RhinoObject.) | |
OnDraw |
Called when Rhino wants to draw this object
(Inherited from RhinoObject.) | |
OnDuplicate |
Called when this a new instance of this object is created and copied from
an existing object
(Inherited from RhinoObject.) | |
OnPick |
Called to determine if this object or some sub-portion of this object should be
picked given a pick context.
(Inherited from RhinoObject.) | |
OnPicked |
Called when this object has been picked
(Inherited from RhinoObject.) | |
OnSelectionChanged |
Called when the selection state of this object has changed
(Inherited from RhinoObject.) | |
OnSpaceMorph |
Called when a space morph has been applied to the geometry.
Currently this only works for CustomMeshObject instances
(Inherited from RhinoObject.) | |
OnSwitchToNonConst |
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.) | |
OnTransform |
Called when a transformation has been applied to the geometry
(Inherited from RhinoObject.) | |
RenderMeshes |
Returns a set of custom render primitives for this object.
(Inherited from RhinoObject.) | |
Select(Boolean) | Selects an object. (Inherited from RhinoObject.) | |
Select(Boolean, Boolean) | Selects an object. (Inherited from RhinoObject.) | |
Select(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) | Selects an object. (Inherited from RhinoObject.) | |
SelectSubObject(ComponentIndex, Boolean, Boolean) | Reports if an object can be selected. (Inherited from RhinoObject.) | |
SelectSubObject(ComponentIndex, Boolean, Boolean, Boolean) | Reports if an object can be selected. (Inherited from RhinoObject.) | |
SetCopyHistoryOnReplace |
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.
(Inherited from RhinoObject.) | |
SetCustomRenderMeshParameter |
Set the named custom render mesh parameter value for this object.
(Inherited from RhinoObject.) | |
SetHistory |
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.
(Inherited from RhinoObject.) | |
SetMesh |
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) | (Inherited from RhinoObject.) | |
SetObjectFrame(Transform) | (Inherited from RhinoObject.) | |
SetRenderMeshParameters |
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.
(Inherited from RhinoObject.) | |
SetTextureMapping(Int32, TextureMapping) | (Inherited from RhinoObject.) | |
SetTextureMapping(Int32, TextureMapping, Transform) |
Sets texture mapping and mapping object transform for a channel
(Inherited from RhinoObject.) | |
ShortDescription |
Gets a localized short descriptive name of the object.
(Inherited from RhinoObject.) | |
ShortDescriptionWithClosedStatus |
Gets a localized short descriptive name of the object, along with it's open/closed status.
(Inherited from RhinoObject.) | |
SupportsRenderPrimitiveList(ViewportInfo, DisplayPipelineAttributes) | Obsolete.
Determines if custom render meshes will be built for a particular object.
(Inherited from RhinoObject.) | |
SupportsRenderPrimitiveList(ViewportInfo, Boolean) | Obsolete.
Determines if custom render meshes will be built for a particular object.
(Inherited from RhinoObject.) | |
ToJSON |
Create a JSON string representation of this object
(Inherited from CommonObject.) | |
ToString |
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.) | |
TryGetGumballFrame |
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.
(Inherited from RhinoObject.) | |
TryGetRenderPrimitiveBoundingBox(ViewportInfo, DisplayPipelineAttributes, BoundingBox) | Obsolete.
Get the bounding box for the custom render meshes associated with this
object.
(Inherited from RhinoObject.) | |
TryGetRenderPrimitiveBoundingBox(ViewportInfo, Boolean, BoundingBox) | Obsolete.
Get the bounding box for the custom render meshes associated with this
object.
(Inherited from RhinoObject.) | |
UnhighlightAllSubObjects |
Removes highlighting from all sub-objects.
(Inherited from RhinoObject.) | |
UnselectAllSubObjects |
Removes selection from all sub-objects.
(Inherited from RhinoObject.) |