Attributes (color, material, layer,...) associated with a rhino object
Constructors
public ObjectAttributes()
ObjectAttributes
#Parameters:
| info (SerializationInfo) | |
| context (StreamingContext) |
Properties
Gets or sets an object's casts shadows property, or whether or not an object casts shadows on other objects and a ground plane.
Defines how a label for a clipping plane object should be shown
The color used to display an object is specified in one of three ways. If ColorSource is ON::color_from_layer, then the object's layer ON_Layer::Color() is used. If ColorSource is ON::color_from_object, then value of m_color is used. If ColorSource is ON::color_from_material, then the diffuse color of the object's render material is used. See ON_3dmObjectAttributes::MaterialSource() to determine where to get the definition of the object's render material.
Returns or sets the per-object render meshing parameters, which controls the object's render mesh density. If this property is null, then the object uses the document's render meshing parameters. To remove the per-object render meshing parameters, set this property to null.
Should the background color show for a detail
Display order used to force objects to be drawn on top or behind each other. Larger numbers draw on top of smaller numbers.
0 = draw object in standard depth buffered order
<0 = draw object behind "normal" draw order objects
>0 = draw object on top of "normal" draw order objects
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
En/disables the custom meshing parameters enabled state.
Get an object that provides access to mesh modifiers when the attributes is for a File3dmObject.
A mapping from any plug-in source is associated with these attributes Need to do this here to respond correctly to ModifyObjectAttributes event
HasUserData
Gets true if this class has any custom information attached to it through UserData.
Fill color for hatches (default is Color.Empty)
Fill color for hatches when printing (default is Color.Empty)
Hatch boundary color override. Default is unset color which means use the standard attributes and layer colors to determine the boundary color
Source for the hatch boundary display color. Determines whether the boundary color is read from the layer, from the object's main attribute color, inherited from the parent, or read from the custom override color set by HatchBoundaryColor (ColorCustom).
Hatch boundary plot color override. Default is unset color which means use the standard attributes and layer colors to determine the boundary color
Source for the hatch boundary plot/print color. Determines whether the boundary plot color is read from the layer, from the object's main attribute color, inherited from the parent, or read from the custom override color set by HatchBoundaryPlotColor (ColorCustom).
Plot width of hatch boundary curves. values less than -1 (-10 is default): plot weight is determined by the m_plot_weight -1: do not plot 0: use default weight defined by the print dialog positive values are thicknesses in millimeters to print to
Draw the bounrdaries for a hatch (default is false)
Overrides: CommonObject.IsDocumentControlled
Use this query to determine if an object is part of an instance definition.
Gets or sets an associated layer index.
Layer definitions in an OpenNURBS model are stored in a layer table. The layer table is conceptually an array of ON_Layer classes. Every OpenNURBS object in a model is on some layer. The object's layer is specified by zero based indices into the ON_Layer array.
Gets or sets the linetype index.
Linetype definitions in an OpenNURBS model are stored in a linetype table. The linetype table is conceptually an array of ON_Linetype classes. Every OpenNURBS object in a model references some linetype. The object's linetype is specified by zero based indices into the ON_Linetype array.
Index 0 is reserved for continuous linetype (no pattern).
Per object linetype scale
The Linetype used to display an object is specified in one of two ways. If LinetypeSource is ON::linetype_from_layer, then the object's layer ON_Layer::Linetype() is used. If LinetypeSource is ON::linetype_from_object, then value of m_linetype is used.
Gets or sets the material index.
If you want something simple and fast, set the index of the rendering material.
If you are developing a high quality plug-in renderer, and a user is assigning a custom render material to this object, then add rendering material information to the MaterialRefs dictionary. Note to developers: As soon as the MaterialRefs dictionary contains items rendering material queries slow down. Do not populate the MaterialRefs dictionary when setting the MaterialIndex will take care of your needs.
Determines if the simple material should come from the object or from it's layer. High quality rendering plug-ins should use m_rendering_attributes.
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.
Gets or sets an object optional text name.
More than one object in a model can have the same name and some objects may have no name.
If ON::color_from_object == ColorSource, then color is the object's display color.
Used to indicate an object has a decoration (like an arrowhead on a curve)
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 object.Id.
The mapping channel id to use when calling MappingChannel to retrieve the OCS mapping if there is one.
Returns: The mapping channel id to use when calling MappingChannel to retrieve the OCS mapping if there is one.
If plot_color_from_object == PlotColorSource, then PlotColor is the object's plotting color.
The color used to plot an object on paper is specified in one of three ways. If PlotColorSource is ON::plot_color_from_layer, then the object's layer ON_Layer::PlotColor() is used. If PlotColorSource is ON::plot_color_from_object, then value of PlotColor() is used.
Plot weight in millimeters. =0.0 means use the default width <0.0 means don't plot (visible for screen display, but does not show on plot)
Gets or sets an object's receives shadows property, or whether or not an object receives shadows from other objects.
Sets the render material for the object - higher level function for setting MaterialSource and MaterialIndex
Where section attributes are read from
Gets or sets the section style index.
Starting with V4, objects can be in either model space or page space. If an object is in page space, then ViewportId is not nil and identifies the page it is on.
Objects may have an URL. There are no restrictions on what value this URL may have. As an example, if the object came from a commercial part library, the URL might point to the definition of that part.
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.
If ViewportId is nil, the object is active in all viewports. If ViewportId is not nil, then this object is only active in a specific view. This field is primarily used to assign page space objects to a specific page, but it can also be used to restrict model space to a specific view.
When a surface object is displayed in wireframe, this controls how many isoparametric wires are used. value number of isoparametric wires -1 boundary wires (off) 0 boundary and knot wires 1 boundary and knot wires and, if there are no interior knots, a single interior wire. N>=2 boundary and knot wires and (N+1) interior wires.
Methods
Make this object hidden in a given detail
Parameters:
| detailId (Guid) |
Adds object to the group with specified index by appending index to group list.
If the object is already in group, nothing is changed.
Parameters:
| groupIndex (int) | The index that will be added. |
public void ClearRenderingAttributes()
Clears, or resets the rendering attributes.
Parameters:
| document (RhinoDoc) |
Parameters:
| document (RhinoDoc) |
public SectionStyle ComputedSectionStyle(RhinoDoc doc, ObjectAttributes sectionerAttributes, bool computeColors, Guid viewport_id)
Parameters:
| doc (RhinoDoc) | |
| sectionerAttributes (ObjectAttributes) | |
| computeColors (bool) | |
| viewport_id (Guid) |
ConstructConstObject
Assigns a parent object and a sub-object index to this.
public void DeleteAllUserStrings()
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
Gets an object's draw color, which is based on the object's color source
Gets an object's draw color, which is based on the object's color source
Parameters:
| document (RhinoDoc) | The object's documnt. |
Returns: The draw color.
Constructs a copy of this ObjectAttributes instance.
Returns: A new instance on success, or null on failure.
EnsurePrivateCopy
public void 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.
Get an optional custom linetype associated with these attributes. If null, then the attributes use the linetype index to determine it's linetype
Get an optional custom section style associated with these attributes.
Returns the id of the display mode of an objects. Object display modes are view based. Thus, it is possible to have an object display different in different views.
Parameters:
| viewportId (Guid) | Id of a Rhino Viewport. |
Returns: A display node id if the object has a display mode override for the viewport; otherwise Guid.Empty is returned.
Returns an array of GroupCount group indices. If GroupCount is zero, then GetGroupList() returns null.
Returns: An array of group indices. null might be returned in place of an empty array.
Get list of details that this object is supposed to be hidden in
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
Gets a user string.
Parameters:
| key (string) | id used to retrieve the string. |
Returns: string associated with the key if successful. null if no key was found.
Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.
Returns: A collection of key strings and values strings. This
Determines if an object has a display mode override for a given viewport.
Parameters:
| viewportId (Guid) | Id of a Rhino Viewport. |
Returns: true if the object has a display mode override for the viewport; otherwise, false.
Is this object supposed to be hidden in a given detail
Parameters:
| detailId (Guid) |
Determines if an object belong to a group or not.
Parameters:
| groupIndex (int) | The index that will be tested. |
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
NonConstOperation
protected virtual void NonConstOperation()
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
OnSwitchToNonConst
protected virtual void OnSwitchToNonConst()
Is called when a non-constant operation first occurs.
public void RemoveCustomLinetype()
public void RemoveCustomSectionStyle()
public void RemoveDisplayModeOverride()
By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This function resets an object to use the viewport's display mode for all viewports.
By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This function resets an object to use the viewport's display mode.
Parameters:
| rhinoViewportId (Guid) | viewport that display mode overrides should be cleared from. |
removes object from the group with specified index.
If the object is not in the group, nothing is changed.
Parameters:
| groupIndex (int) | The index that will be removed. |
Remove hidden in detail flag for a specific detail
Parameters:
| detailId (Guid) |
Parameters:
| linetype (Linetype) |
Parameters:
| sectionStyle (SectionStyle) |
By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This version sets a display mode for a specific viewport.
Parameters:
| mode (DisplayModeDescription) | The display mode. |
| rhinoViewportId (Guid) | The Rhino viewport ID. |
Returns: true on success.
By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This version affects the object's display mode for all viewports.
Parameters:
| mode (DisplayModeDescription) | The display mode. |
Returns: true if setting was successful.
Attach a user string (key,value combination) to this geometry.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |