ObjectAttributes

ObjectAttributes class

Attributes (color, material, layer,...) associated with a rhino object

Inheritence: Rhino.Runtime.CommonObjectObjectAttributes
Derived Classes:

Namespace: Rhino.DocObjects
ObjectAttributes: references

Constructors (4)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

ObjectAttributes()

ObjectAttributes(SerializationInfo info, StreamingContext context)

Properties (46)

CastsShadows

Gets or sets an object's casts shadows property, or whether or not an object casts shadows on other objects and a ground plane.

ClippingPlaneLabelStyle

Defines how a label for a clipping plane object should be shown

ColorSource

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.

CustomMeshingParameters

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.

Decals

Gets all object decals associated with this object.

DisplayOrder

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.

File3dmMeshModifiers

Get an object that provides access to mesh modifiers when the attributes is for a File3dmObject.

GroupCount

number of groups object belongs to.

HasMapping

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.

HatchBackgroundFillColor

Fill color for hatches (default is Color.Empty)

HatchBoundaryVisible

Draw the bounrdaries for a hatch (default is false)

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.

IsInstanceDefinitionObject

Use this query to determine if an object is part of an instance definition.

IsValid

Tests an object to see if it is valid.

LayerIndex

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.

LinetypeIndex

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

LinetypePatternScale

Per object linetype scale

LinetypeSource

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.

MaterialIndex

Gets or sets the material index.
If you want something simple and fast, set the index of the rendering material.

MaterialRefs

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.

MaterialSource

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.

Mode

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.

Name

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.

ObjectColor

If ON::color_from_object == ColorSource, then color is the object's display color.

ObjectDecoration

Used to indicate an object has a decoration (like an arrowhead on a curve)

ObjectId

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

OCSMappingChannelId

The mapping channel id to use when calling MappingChannel to retrieve the OCS mapping if there is one.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

PlotColor

If plot_color_from_object == PlotColorSource, then PlotColor is the object's plotting color.

PlotColorSource

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.

PlotWeight

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)

PlotWeightSource

ReceivesShadows

Gets or sets an object's receives shadows property, or whether or not an object receives shadows from other objects.

RenderMaterial

Sets the render material for the object - higher level function for setting MaterialSource and MaterialIndex

SectionAttributesSource

Where section attributes are read from

Space

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.

Url

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.

UserStringCount

ViewportId

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.

Visible

Gets or sets an object's visibility.

WireDensity

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

AddHideInDetailOverride(Guid detailId)

Make this object hidden in a given detail

AddToGroup(Int32 groupIndex)

Adds object to the group with specified index by appending index to group list.
If the object is already in group, nothing is changed.

ComputedPlotColor(RhinoDoc document,Guid viewportId)

ComputedPlotColor(RhinoDoc document)

ComputedPlotWeight(RhinoDoc document,Guid viewportId)

ComputedPlotWeight(RhinoDoc document)

ConstructConstObject(Object parentObject,Int32 subobjectIndex)

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

DeleteAllUserStrings()

DeleteUserString(String key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(Boolean 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.

DrawColor(RhinoDoc document,Guid viewportId)

Gets an object's draw color, which is based on the object's color source

DrawColor(RhinoDoc document)

Gets an object's draw color, which is based on the object's color source

Duplicate()

Constructs a copy of this <b>ObjectAttributes</b> instance.

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(Int32 archive3dm,Int32 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

GetCustomLinetype()

Get an optional custom linetype associated with these attributes. If null, then the attributes use the linetype index to determine it's linetype

GetCustomSectionStyle()

Get an optional custom section style associated with these attributes.

GetDisplayModeOverride(Guid viewportId)

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.

GetGroupList()

Returns an array of GroupCount group indices. If GroupCount is zero, then GetGroupList() returns null.

GetHideInDetailOverrides()

Get list of details that this object is supposed to be hidden in

GetObjectData(SerializationInfo info,StreamingContext context)

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

GetUserString(String key)

Gets a user string.

GetUserStrings()

Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.

HasDisplayModeOverride(Guid viewportId)

Determines if an object has a display mode override for a given viewport.

HasHideInDetailOverrideSet(Guid detailId)

Is this object supposed to be hidden in a given detail

IsValidWithLog(String log)

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

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

ObjectFrame()

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

RemoveCustomLinetype()

RemoveCustomSectionStyle()

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.

RemoveDisplayModeOverride(Guid rhinoViewportId)

RemoveFromAllGroups()

Removes object from all groups.

RemoveFromGroup(Int32 groupIndex)

removes object from the group with specified index.
If the object is not in the group, nothing is changed.

RemoveHideInDetailOverride(Guid detailId)

Remove hidden in detail flag for a specific detail

SetCustomLinetype(Linetype linetype)

SetCustomSectionStyle(SectionStyle sectionStyle)

SetDisplayModeOverride(DisplayModeDescription mode,Guid rhinoViewportId)

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.

SetDisplayModeOverride(DisplayModeDescription mode)

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.

SetObjectFrame(Plane plane)

SetObjectFrame(Transform xform)

SetUserString(String key,String value)

Attach a user string (key,value combination) to this geometry.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

Transform(Transform xform)

Apply a transformation.

Nothing found