TextObject

Remarks: Guid.Empty both for default grips and for no grips at all. RhinoObject.GripsOn tells those two apart. Record it to replay a grip selection later: handing it back to RhinoObject.EnableGrips(Guid) restores the same kind. From a grip, reach it as GripObject.Owner.RhinoObject.EnabledGripsId.

Geometry

Gets the underlying geometry for this object.

All rhino objects are composed of geometry and attributes.

public virtual GeometryBase Geometry { get; }

GripsOn

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

public bool GripsOn { get; set; }

GripsSelected

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

public bool GripsSelected { get; }

GroupCount

Number of groups object belongs to.

public int GroupCount { get; }

HasDynamicTransform

True if the object has a dynamic transformation

public bool HasDynamicTransform { get; }

HasId

Returns a value indicating whether the component has an ID.

public bool HasId { get; }

HasIndex

Returns a value indicating whether the component has an Index.

public bool HasIndex { get; }

inherited fromAnnotationObjectBase

HasMeasurableTextFields

Test if the text in the annotation object contains fields that involve length, area, or volume measurements

public bool HasMeasurableTextFields { get; }

HasName

Returns a value indicating whether the component has a Name.

public bool HasName { get; }

HasSubobjectMaterials

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

public bool HasSubobjectMaterials { get; }

HasUserData

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

public bool HasUserData { get; }

Id

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 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.

public override Guid Id { get; set; }

Overrides: ModelComponent.Id

IdIsLocked

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

public bool IdIsLocked { get; }

Index

Gets or sets the model component index attribute.

public virtual int Index { get; set; }

Exceptions:

When setting the Index failed. This usually happens because the instance Index is already locked.

IndexIsLocked

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

public bool IndexIsLocked { get; }

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.

[CLSCompliant(false)] public override uint InstanceDefinitionModelSerialNumber { get; }

Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

Overrides: ModelComponent.InstanceDefinitionModelSerialNumber

IsComponentStatusLocked

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

public bool IsComponentStatusLocked { get; }

IsDeletable

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

public bool IsDeletable { get; protected set; }

IsDeleted

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

public override bool IsDeleted { get; }

Overrides: ModelComponent.IsDeleted

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.

public virtual bool IsDocumentControlled { get; }

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.

public bool IsHidden { get; }

IsInstanceDefinitionGeometry

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

public bool IsInstanceDefinitionGeometry { get; }

IsLocked

public bool IsLocked { get; }

IsNormal

public bool IsNormal { get; }

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.

public bool IsPictureFrame { get; }

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.

public override bool IsReference { get; }

Overrides: ModelComponent.IsReference

IsSolid

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

public bool IsSolid { get; }

IsSystemComponent

True if this model component is a system constant.

An incomplete list of system constant model components is below:

ON_ModelComponent::Unset
ON_InstanceDefinition::Empty
ON_Linetype::Unset
ON_Linetype::Continuous
ON_Linetype::ByLayer
ON_Linetype::ByParent
ON_Layer::Unset
ON_Layer::Default
ON_TextStyle::Unset
ON_TextStyle::Default
ON_TextStyle::ByLayer
ON_TextStyle::ByParent
ON_DimStyle::Unset
ON_DimStyle::Default
ON_DimStyle::DefaultInchDecimal
ON_DimStyle::DefaultInchFractional
ON_DimStyle::DefaultFootInchArchitecture
ON_DimStyle::DefaultMillimeterSmall
ON_DimStyle::DefaultMillimeterLarge
ON_DimStyle::DefaultMillimeterArchitecture

public bool IsSystemComponent { get; }

IsValid

Tests an object to see if it is valid.

public virtual bool IsValid { get; }

ModelSerialNumber

A value identifying the model that manages this component.

[CLSCompliant(false)] public virtual uint ModelSerialNumber { get; }

Remarks: If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

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.

public override string Name { get; set; }

Overrides: ModelComponent.Name

NameIsLocked

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

public bool NameIsLocked { get; }

ObjectType

Gets the Rhino-based object type.

[CLSCompliant(false)] public ObjectType ObjectType { get; }

ReferenceModelSerialNumber

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

[CLSCompliant(false)] public override uint ReferenceModelSerialNumber { get; }

Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

Overrides: ModelComponent.ReferenceModelSerialNumber

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.

public RenderMaterial RenderMaterial { get; set; }

RuntimeSerialNumber

Gets the objects runtime serial number.

[CLSCompliant(false)] public uint RuntimeSerialNumber { get; }

SubobjectMaterialComponents

public ComponentIndex[] SubobjectMaterialComponents { get; }

TextGeometry

#Since v5.0

Get the text geometry for this object.

public TextEntity TextGeometry { get; }

UsePreviewMesh

True when the display should draw this object's preview mesh instead of its render or analysis mesh.

public bool UsePreviewMesh { get; }

Remarks: Only meaningful while drawing: the meshing worker thread raises this for the objects it is previewing and it is false the rest of the time. A texture or false colour VisualAnalysisMode reads it from SetUpDisplayAttributes to decide whether to show mesh wires, which is what the built-in analysis modes do.

UserData

List of custom information that is attached to this class.

public UserDataList UserData { get; }

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.

public ArchivableDictionary UserDictionary { get; }

Visible

Gets the object visibility.

public bool Visible { get; }

WorksessionReferenceSerialNumber

Obsolete - use ReferenceModelSerialNumber

[EditorBrowsable(EditorBrowsableState.Never)] [CLSCompliant(false)] public uint WorksessionReferenceSerialNumber { get; }

Methods

ClearId

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

public void ClearId()

Exceptions:

If the ID is locked.

ClearIndex

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

public void ClearIndex()

Exceptions:

If the index is locked.

ClearName

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

public void ClearName()

Exceptions:

If the name is locked.

CommitChanges

Moves changes made to this RhinoObject into the RhinoDoc.

public bool CommitChanges()

Returns: true if changes were made.

ConstructConstObject

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

protected void ConstructConstObject(

object

parentObject,

The parent object.

int

subobjectIndex

The sub-object index.

)

CopyHistoryOnReplace

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

public bool CopyHistoryOnReplace()

Returns: true if this object has history and the field is set false otherwise

CreateMeshes

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

public virtual int CreateMeshes(

meshType,

type of meshes to create

MeshingParameters

parameters,

in parameters that control the quality of the meshes that are created

bool

ignoreCustomParameters

Default should be false. Should the object ignore any custom meshing parameters on the object's attributes

)

Returns: number of meshes created

CreateSections

Generate section curves by intersecting a plane with an object of type Brep, Extrusion, SubD ,Mesh or Block Instance.

public GeometryBase[] CreateSections(

Plane

plane,

Intersecting plane.

name,

Name for section of objects.

double

tolerance,

The intersection tolerance. When in doubt, use the document's model absolute tolerance.

out ObjectAttributes[]

objectAttributes

Object attributes, one for each returned geometry item.

)

Returns: Section geometry in the form of Breps, Extrusions, Meshes, and Curves if successful. An empty array if unsuccessful.

CreateSlices

Generate slices by intersecting a plane with an object of type Brep, Extrusion, SubD , Mesh, or Block Instance.

public GeometryBase[] CreateSlices(

Plane

centerPlane,

Intesecting plane.

name,

Name for section of objects.

double

thickness,

Thickness of the slice. If thickness is less than tolerance, a surface will be created instead of a solid slice.

double

tolerance,

The intersection tolerance. When in doubt, use the document's model absolute tolerance.

out ObjectAttributes[]

objectAttributes

Object attributes, one for each returned geometry item.

)

Returns: Slice geometry in the form of Breps, Extrusions, Meshes, and Curves if successful. An empty array if unsuccessful.

CustomRenderMeshesBoundingBox

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

public bool CustomRenderMeshesBoundingBox(

mt,

The mesh type requested (render or analysis).

vp,

The viewport being rendered

ref Flags

flags,

See RenderMeshProvider.Flags. This is an in/out parameter: on return it also carries any status flags, so reset it before each call. See RhinoObject.RenderMeshes(MeshType, ViewportInfo, List<InstanceObject>, RenderMeshProvider.Flags, PlugIn, DisplayPipelineAttributes) for how to wait for an asynchronous provider.

PlugIn

plugin,

The requesting plug-in (typically the calling plugin)

attrs,

Display attributes for the caller - null if this is a full rendering.

out BoundingBox

boundingBox

The requested bounding box

)

Returns: True if the process was a success

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

[CLSCompliant(false)] public uint DataCRC(

uint

currentRemainder

The current remainder value.

)

Returns: The updated remainder value.

DeleteHistoryRecord

For expert use only. Deletes existing history record

public bool DeleteHistoryRecord()

Returns: true if history record was purged

Description

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

public void Description(

TextLog

textLog

A text log for collecting the description.

)

DestroyMeshes

Destroys cached meshes of type meshType

public virtual void DestroyMeshes(

meshType

type of meshes to create

)

Returns: number of meshes created

Dispose

Actively reclaims unmanaged resources that this instance uses.

public void Dispose()

Dispose

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.

protected virtual void Dispose(

bool

disposing

true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.

)

DuplicateGeometry

Constructs a deep (full) copy of the geometry.

public GeometryBase DuplicateGeometry()

Returns: A copy of the internal geometry.

EnableCustomGrips

Turns on/off the object's editing grips.

public bool EnableCustomGrips(

CustomObjectGrips

customGrips

The custom object grips.

)

Returns: true if the call succeeded. If you attempt to add custom grips to an object that does not support custom grips, then false is returned.

EnableEditPointGrips

Turns on edit point grips, the ones the EditPtOn command turns on.

public bool EnableEditPointGrips()

Remarks: Curves and SubDs carry separate kinds of edit point grips. This picks the one that suits the object, as EditPtOn does, so a caller does not have to. An object that is neither is left exactly as it was. For a curve or a SubD, what happens to grips already on is described by RhinoObject.EnableGrips(Guid).

Returns: true if the object has edit point grips when this returns. false for an object that has none: anything that is not a curve or a SubD, a curve with more than 1000 edit points or too few control points to have any, an empty SubD, and the cases RhinoObject.EnableGrips(Guid) returns false for.

EnableGrips

Turns on grips of one particular kind, replacing grips of any other kind.

public bool EnableGrips(

Guid

gripsId

Id of a grips enabler registered with CustomObjectGrips.RegisterGripsEnabler(TurnOnGripsEventHandler, Type). Guid.Empty means no custom grips: the object's own default grips, which is what the PointsOn command turns on. For edit points call RhinoObject.EnableEditPointGrips() rather than naming a kind here; curves and SubDs use different ones and it picks between them.

)

Remarks:

Grips that were on are put back when the requested kind cannot be made, so a false return leaves the object with the grips it had.

Except when the requested kind is already on, the grips are new objects afterwards and a GripObject held across this call is stale.

Grips this turns on are not subject to Automatic Points On. They stay on until something turns them off, as with PointsOn and EditPtOn.

Returns: true if the object has grips of the requested kind when this returns. false if nothing is registered for gripsId, if the object has no grips of that kind (a polysurface has no default grips), or if the grips already on refused to turn off, which they do while they are being dragged.

EnableVisualAnalysisMode

Used to turn analysis modes on and off.

public bool EnableVisualAnalysisMode(

VisualAnalysisMode

mode,

A visual analysis mode.

bool

enable

true if the mode should be activated; false otherwise.

)

Returns: true if this object supports the analysis mode.

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

GetActiveVisualAnalysisModes

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

public VisualAnalysisMode[] GetActiveVisualAnalysisModes()

Returns: An array of visual analysis modes. The array can be empty, but not null.

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

protected virtual BoundingBox GetBoundingBox(

RhinoViewport

viewport

For objects like labels or lights, the viewport in which the bounding box should be calculated. Otherwise null.

)

Returns: The bounding box.

GetCustomRenderMeshParameter

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

[CLSCompliant(false)] public virtual IConvertible GetCustomRenderMeshParameter(

Guid

providerId,

Id of the custom render mesh provider

parameterName

Name of the parameter

)

Returns: IConvertible. Note that you can't directly cast from object, instead you have to use the Convert mechanism.

GetDynamicTransform

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

public bool GetDynamicTransform(

out Transform

transform

)

Returns: True if the object is being edited and its transformation is available. False if the object is not being edited, in which case the identity transform is returned.

GetGrips

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

public GripObject[] GetGrips()

Returns: An array of grip objects; or null if there are no grips.

GetGroupList

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

public int[] GetGroupList()

Returns: An array of group indices, or null if RhinoObject.GroupCount is 0.

GetHighlightedSubObjects

Gets a list of all highlighted sub-objects.

public ComponentIndex[] GetHighlightedSubObjects()

Returns: An array of all highlighted sub-objects; or null is there are none.

GetMaterial

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.

public Material GetMaterial(

bool

frontMaterial

If true, gets the material used to render the object's front side

)

GetMaterial

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.

public Material GetMaterial(

componentIndex,

Returns the material associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

Guid

plugInId,

The plug-in specific material to look for.

ObjectAttributes

attributes

Optional object attributes used to determine the material source, if null the objects attributes are used.

)

Returns: Returns 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

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.

public Material GetMaterial(

componentIndex,

Returns the material associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

Guid

plugInId

The plug-in specific material to look for.

)

Returns: Returns 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

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.

public Material GetMaterial(

componentIndex

Returns the material associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

)

Returns: Returns 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

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

public virtual Mesh[] GetMeshes(

meshType

)

Returns: An array of meshes.

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(

SerializationInfo

info,

The System.Runtime.Serialization.SerializationInfo to populate with data.

StreamingContext

context

The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.

)

GetRenderMaterial

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.

public RenderMaterial GetRenderMaterial(

bool

frontMaterial

If true, gets the material used to render the object's front side otherwise; gets the material used to render the back side of the object.

)

Returns: If there is a RenderMaterial associated with this objects' associated Material then it is returned otherwise; null is returned.

GetRenderMaterial

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.

public RenderMaterial GetRenderMaterial(

componentIndex,

Returns the RenderMaterial associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

Guid

plugInId,

The plug-in specific material to look for.

ObjectAttributes

attributes

Optional object attributes used to determine the material source, if null the objects attributes are used.

)

Returns: Returns the RhinoObject.RenderMaterial associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level RenderMaterail is returned. If this method returns null it means there is no RenderMaterial associated with the object or sub object so you should may GetMaterial get the objects generic material.

GetRenderMaterial

public RenderMaterial GetRenderMaterial(

componentIndex,

Returns the RenderMaterial associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

Guid

plugInId

The plug-in specific material to look for.

)

GetRenderMaterial

public RenderMaterial GetRenderMaterial(

componentIndex

Returns the RenderMaterial associated with the specified sub object or the objects top level material if it is set to ComponentIndex.Unset

)

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.

public MeshingParameters GetRenderMeshParameters()

Returns: The render meshing parameters.

GetRenderMeshParameters

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

public MeshingParameters GetRenderMeshParameters(

bool

returnDocumentParametersIfUnset

If true, then return the per-object meshing parameters for this object. If this object does not have per-object meshing parameters, then the document's meshing parameters are returned. If false, then return the per-object meshing parameters for this object. If this object does not have per-object meshing parameters, then null is returned.

)

Returns: The render meshing parameters if successful, null otherwise.

GetRenderPrimitiveList

Build custom render mesh(es) for this object.

public RenderPrimitiveList GetRenderPrimitiveList(

viewport,

The viewport being rendered.

bool

preview

Type of mesh to build, if preview is true then a smaller mesh may be generated in less time, false is meant when actually rendering.

)

obsoleteThis version is obsolete because it returns the obsolete RenderPrimitiveList - ie, the old school custom render meshes. Use CustomRenderMeshes instead.

Returns: Returns a RenderPrimitiveList if successful otherwise returns null.

GetRenderPrimitiveList

Build custom render mesh(es) for this object.

public RenderPrimitiveList GetRenderPrimitiveList(

viewport,

The viewport being rendered.

attrs

Attributes for the view mode you are supplying meshes for. Will be null if this is a modal rendering.

)

obsoleteThis version is obsolete because it returns the obsolete RenderPrimitiveList - ie, the old school custom render meshes. Use CustomRenderMeshes instead.

Returns: Returns a RenderPrimitiveList if successful otherwise returns null.

GetSelectedSubObjects

Get a list of all selected sub-objects.

public ComponentIndex[] GetSelectedSubObjects()

Returns: An array of sub-object indices, or null if there are none.

GetSubObjects

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

public RhinoObject[] GetSubObjects()

Returns: An array of Rhino objects, or null if this object cannot be exploded.

GetTextCorners

#Since v7.21

Gets the world 3D corner points of the whole text object.

public Point3d[] GetTextCorners(

RhinoViewport

viewport

The viewport in which to make the calculation.

)

Returns: The four corner points if successful, an empty array on failure.

Exceptions:

ArgumentNullException

GetTextureChannels

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

public int[] GetTextureChannels()

Returns: Returns an array of channel Id's or an empty list if there are not mappings.

GetTextureMapping

Get objects texture mapping

public TextureMapping GetTextureMapping(

int

channel,

out Transform

objectTransform

)

GetTextureMapping

public TextureMapping GetTextureMapping(

int

channel

)

GetTightBoundingBox

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

protected virtual bool GetTightBoundingBox(

ref BoundingBox

tightBox,

Beginning and resulting tight box

bool

growBox,

If true and the input tight_bbox is valid, then returned tight_bbox is the union of the input tight_bbox and the tight bounding box of this Rhino object.

xform

If useXform==true, the tight bounding box of the transformed Rhino object is calculated.

)

Returns: true if the returned tight_bbox is set to a valid bounding box.

HasCustomRenderMeshes

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

public bool HasCustomRenderMeshes(

mt,

The mesh type requested (render or analysis).

vp,

The viewport being rendered.

ref Flags

flags,

PlugIn

plugin,

The requesting plug-in (typically the calling plugin)

attrs

Display attributes for the caller - null if this is a full rendering.

)

Returns: Returns true if the object will has a set of custom render primitives

HasHistoryRecord

Returns whether this object has a history record

public bool HasHistoryRecord()

HasTextureMapping

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

public bool HasTextureMapping()

Highlight

Modifies the highlighting of the object.

public bool Highlight(

bool

enable

true if highlighting should be enabled.

)

Returns: true if the object is now highlighted.

HighlightSubObject

Highlights a sub-object.

public bool HighlightSubObject(

componentIndex,

A sub-object component index.

bool

highlight

true if the sub-object should be highlighted.

)

Returns: true if the sub-object is now highlighted.

HistoryChildren

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

public Guid[] HistoryChildren()

Returns: An array of Rhino object ids if successful, an empty array if the object has no children or on error.

HistoryParents

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

public Guid[] HistoryParents()

Returns: An array of Rhino object ids if successful, an empty array if the object has no parents or on error.

InVisualAnalysisMode

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

public bool InVisualAnalysisMode()

Returns: true if an analysis mode is active; otherwise false.

InVisualAnalysisMode

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

public bool InVisualAnalysisMode(

VisualAnalysisMode

mode

The mode to check for.

Use null if you want to see if any mode is active.

)

Returns: true if the specified analysis mode is active; otherwise false.

IsActiveInViewport

Determine if this object is active in a particular viewport.

public virtual bool IsActiveInViewport(

RhinoViewport

viewport

)

Remarks: The default implementation tests for space and viewport id. This handles things like testing if a page space object is visible in a modeling view.

Returns: True if the object is active in viewport

IsHighlighted

Check highlight state.

public int IsHighlighted(

bool

checkSubObjects

If true and the entire object is not highlighted, and some subset of the object is highlighted, like some edges of a surface, then 3 is returned. If false and the entire object is not highlighted, then zero is returned.

)

Returns:

0: object is not highlighted.

1: entire object is highlighted.

3: one or more proper sub-objects are highlighted.

IsMeshable

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

public virtual bool IsMeshable(

meshType

)

IsSelectable

Reports if an object can be selected.

public bool IsSelectable()

Remarks: Objects that are locked, hidden, or on locked or hidden layers cannot be selected. If IsSelectableWithGripsOn() returns false, then an that object is not selectable if it has grips turned on.

Returns: true if object is capable of being selected.

IsSelectable

Reports if an object can be selected.

public bool IsSelectable(

bool

ignoreSelectionState,

If true, then selected objects are selectable. If false, then selected objects are not selectable.

bool

ignoreGripsState,

If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected.

bool

ignoreLayerLocking,

If true, then objects on locked layers are selectable. If false, then objects on locked layers are not selectable.

bool

ignoreLayerVisibility

If true, then objects on hidden layers are selectable. If false, then objects on hidden layers are not selectable.

)

Returns: true if object is capable of being selected.

IsSelected

Check selection state.

public int IsSelected(

bool

checkSubObjects

(false is good default) If true and the entire object is not selected, and some subset of the object is selected, like some edges of a surface, then 3 is returned. If false and the entire object is not selected, then zero is returned.

)

Returns: 0 = object is not selected. 1 = object is selected. 2 = entire object is selected persistently. 3 = one or more proper sub-objects are selected.

IsSubObjectHighlighted

Determines if a sub-object is highlighted.

public bool IsSubObjectHighlighted(

componentIndex

A sub-object component index.

)

Returns: true if the sub-object is highlighted.

IsSubObjectSelectable

Reports if a sub-object can be selected.

public bool IsSubObjectSelectable(

componentIndex,

index of sub-object to check.

bool

ignoreSelectionState

If true, then selected objects are selectable. If false, then selected objects are not selectable.

)

Remarks: Objects that are locked, hidden, or on locked or hidden layers cannot be selected. If IsSelectableWithGripsOn() returns false, then that object is not selectable if it has grips turned on.

Returns: true if the specified sub-object can be selected.

IsSubObjectSelected

Check sub-object selection state.

public bool IsSubObjectSelected(

componentIndex

Index of sub-object to check.

)

Remarks: A sub-object cannot be persistently selected.

Returns: true if the sub-object is selected.

IsValidWithLog

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

public bool IsValidWithLog(

out string

log

A textual log. This out parameter is assigned during this call.

)

Returns: true if this object is valid; false otherwise.

LockId

Locks the component Id property.

public void LockId()

LockIndex

Locks the component Index property.

public void LockIndex()

LockName

Locks the component Name property.

public void LockName()

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.

[CLSCompliant(false)] public uint MemoryEstimate()

Returns: The estimated number of bytes this object occupies in memory.

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.

public virtual int MeshCount(

meshType,

type of mesh to count

MeshingParameters

parameters

if not null and if the object can change its mesh (like a brep), then only meshes that were created with these mesh parameters are counted.

)

Returns: number of meshes

NonConstOperation

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

protected virtual void NonConstOperation()

ObjectFrame

public Plane ObjectFrame()

ObjectFrame

public Plane ObjectFrame(

ObjectFrameFlags

flags

)

OnAddToDocument

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

protected virtual void OnAddToDocument(

RhinoDoc

doc

)

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.

protected virtual void OnDeleteFromDocument(

RhinoDoc

doc

)

OnDraw

Called when Rhino wants to draw this object

protected virtual void OnDraw(

DrawEventArgs

)

OnDuplicate

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

protected virtual void OnDuplicate(

RhinoObject

source

)

OnPick

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

protected virtual IEnumerable<ObjRef> OnPick(

PickContext

context

)

OnPicked

Called when this object has been picked

protected virtual void OnPicked(

PickContext

context,

IEnumerable<ObjRef>

pickedItems

Items that were picked. This parameter is enumerable because there may have been multiple sub-objects picked

)

OnSelectionChanged

Called when the selection state of this object has changed

protected virtual void OnSelectionChanged()

OnSpaceMorph

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

protected virtual void OnSpaceMorph(

SpaceMorph

morph

)

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

protected virtual void OnSwitchToNonConst()

OnTransform

Called when a transformation has been applied to the geometry

protected virtual void OnTransform(

transform

)

RenderMeshes

Returns a set of custom render primitives for this object.

Some providers - Displacement in particular - compute their meshes asynchronously. Until that work finishes, this method returns the object's ordinary render mesh instead of the custom one and reports that by setting RenderMeshProvider.Flags.Incomplete in flags. That mesh is valid geometry but does not yet reflect the provider, so a caller that measures it will see the object as it was beforehand. Test for the flag rather than trusting the first result.

public RenderMeshes RenderMeshes(

mt,

The mesh type requested (render or analysis).

vp,

The viewport being rendered

List<InstanceObject>

ancestry,

The ancestry tree - only used for by-parent object properties assignments.

ref Flags

flags,

On input, the options to apply; on return, the same value with any status flags added. Reset it before each call rather than passing the returned value back in. To wait for an asynchronous provider, call again while RenderMeshProvider.Flags.Incomplete remains set, calling RhinoApp.Wait() in between: the provider needs the main thread's message queue pumped before it can publish its result, so a retry loop that does not pump will never see the flag clear.

PlugIn

plugin,

The requesting plug-in (typically the calling plugin)

attrs

Display attributes for the caller - null if this is a full rendering.

)

Returns: A set of custom render primitives for this object, or the object's ordinary render mesh if an asynchronous provider has not finished - see flags. Null if the object is not in a document.

Select

Selects an object.

public int Select(

bool

on,

The new selection state; true activates selection.

bool

syncHighlight,

If true, then the object is highlighted if it is selected and unhighlighted if is not selected.

Highlighting can be and stay out of sync, as its specification is independent.

bool

persistentSelect,

Objects that are persistently selected stay selected when a command terminates.

bool

ignoreGripsState,

If true, then objects with grips on can be selected. If false, then the value returned by the object's IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.

bool

ignoreLayerLocking,

If true, then objects on locked layers can be selected. If false, then objects on locked layers cannot be selected.

bool

ignoreLayerVisibility

If true, then objects on hidden layers can be selectable. If false, then objects on hidden layers cannot be selected.

)

Returns:

0: object is not selected.

1: object is selected.

2: object is selected persistently.

Select

Selects an object.

public int Select(

bool

on,

The new selection state; true activates selection.

bool

syncHighlight

If true, then the object is highlighted if it is selected and not highlighted if is not selected.

Highlighting can be and stay out of sync, as its specification is independent.

)

Returns:

0: object is not selected.

1: object is selected.

2: object is selected persistently.

Select

Selects an object.

public int Select(

bool

The new selection state; true activates selection.

)

Returns:

0: object is not selected.

1: object is selected.

2: object is selected persistently.

SelectSubObject

Reports if an object can be selected.

public int SelectSubObject(

componentIndex,

Index of sub-object to check.

bool

select,

The new selection state; true activates selection.

bool

syncHighlight,

(default=true) If true, then the object is highlighted if it is selected and unhighlighted if is not selected.

bool

persistentSelect

When true, selection persists even after the current command terminates.

)

Returns:

0: object is not selected

1: object is selected

2: object is selected persistently.

SelectSubObject

Reports if an object can be selected.

public int SelectSubObject(

componentIndex,

Index of sub-object to check.

bool

select,

The new selection state; true activates selection.

bool

syncHighlight

(default=true) If true, then the object is highlighted if it is selected and unhighlighted if is not selected.

)

Returns: 0: object is not selected 1: object is selected 2: object is selected persistently.

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.

public void SetCopyHistoryOnReplace(

bool

bCopy

)

SetCustomRenderMeshParameter

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

public virtual void SetCustomRenderMeshParameter(

Guid

providerId,

Id of the custom render mesh provider

parameterName,

object

value

)

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.

public bool SetHistory(

HistoryRecord

history

The history record.

)

Returns: true if successful, otherwise false.

SetObjectFrame

public void SetObjectFrame(

Plane

plane

)

obsoleteUse Attributes.SetObjectFrame instead

SetObjectFrame

public void SetObjectFrame(

xform

)

obsoleteUse Attributes.SetObjectFrame instead

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.

public bool SetRenderMeshParameters(

MeshingParameters

The per-object meshing parameters. Note: if null, then the per-object meshing parameters will be removed, and this object will revert to using the meshing parameters provided by the document.

)

Returns: True if successful, false otherwise.

SetTextureMapping

Sets texture mapping and mapping object transform for a channel

public int SetTextureMapping(

int

channel,

TextureMapping

tm,

The TextureMapping to set into this channel, or null to remove a texture mapping from a channel.

objectTransform

Mapping channel object transform

)

SetTextureMapping

public int SetTextureMapping(

int

channel,

TextureMapping

)

ShortDescription

Gets a localized short descriptive name of the object.

public virtual string ShortDescription(

bool

plural

true if the descriptive name should in plural.

)

Returns: A string with the short localized descriptive name.

ShortDescriptionWithClosedStatus

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

public string ShortDescriptionWithClosedStatus(

bool

prepend,

true if "open" or "closed" should be prepended to the descriptive name.

bool

plural,

true if the descriptive name should in plural.

out int

status

The open/closed status, where: 0 = undefined, 1 = open, 2 = closed.

)

Returns: A string with the short localized descriptive name.

SupportsRenderPrimitiveList

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

public bool SupportsRenderPrimitiveList(

viewport,

The viewport being rendered.

bool

preview

Type of mesh to build. If attributes is non-null then a smaller mesh may be generated in less time, false is meant when actually rendering.

)

obsoleteUse HasCustomRenderPrimitives instead

Returns: Returns true if custom render mesh(es) will get built for this object.

SupportsRenderPrimitiveList

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

public bool SupportsRenderPrimitiveList(

viewport,

The viewport being rendered.

attrs

Type of mesh to build. If attributes is non-null then a smaller mesh may be generated in less time, false is meant when actually rendering.

)

obsoleteUse HasCustomRenderPrimitives instead

Returns: Returns true if custom render mesh(es) will get built for this object.

ToJSON

Create a JSON string representation of this object

public string ToJSON(

SerializationOptions

options

)

ToString

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

public override string ToString()

Remarks: This is provided as a visual aid. Do not rely on this for serialization.

Overrides: Object.ToString

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.

public bool TryGetGumballFrame(

out GumballFrame

frame

The gumball frame.

)

Returns: true if the object has a gumball frame, otherwise false.

TryGetGumballFrameForCurrentAlignment

Gets the gumball frame for this object under the current gumball alignment mode (Object / World / CPlane). For Object mode the frame always reflects the object's orientation (including any user relocation in that mode). For World and CPlane mode the frame is only returned when the user has manually repositioned the gumball for this object; if it has never been moved in that mode, the method returns false. Sub-object selections are not taken into account; this is a whole-object helper.

public bool TryGetGumballFrameForCurrentAlignment(

out GumballFrame

frame

The gumball frame for the current alignment mode.

)