T_Rhino_Geometry_ComponentStatus - mcneel/rhinocommon-api-docs GitHub Wiki

ComponentStatus Structure

Provides information about selection, highlighting, visibility, editability and integrity states of a component. This structure is immutable.

Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public struct ComponentStatus : IEquatable<ComponentStatus>

VB

Public Structure ComponentStatus
	Implements IEquatable(Of ComponentStatus)

The ComponentStatus type exposes the following members.

Properties

 

Name Description
Public propertyStatic member AllSet All flags are checked.
Public propertyStatic member Clear This is the default value and equal to undefined.
Public propertyStatic member Damaged The damaged flag is checked.
Public propertyStatic member Hidden The hidden flag is checked.
Public propertyStatic member Highlighted The highlight selection flag is checked.
Public property IsClear True if every setting is 0 or false.
Public property IsDamaged Returns false if component is not damaged. True otherwise.
Public property IsHidden Returns true if hidden. False otherwise.
Public property IsHighlighted Returns true if highlighted. False otherwise.
Public property IsLocked Returns true if locked. False otherwise.
Public property IsSelected Returns true if selected or selected persistent. False otherwise.
Public property IsSelectedPersistent Returns true if selected persistent. False otherwise.
Public propertyStatic member Locked The locked flag is checked.
Public propertyStatic member Selected The selection flag is checked.
Public propertyStatic member SelectedPersistent The persistent selection flag is checked.
  Back to Top

Methods

 

Name Description
Public method Equals(Object) Determines if an object and this are equal. (Overrides ValueType.Equals(Object).)
Public method Equals(ComponentStatus) Determines if another ComponentStatus and this are equal.
Public method GetHashCode Serves as a special hash function. The inner value is used for the purpose. (Overrides ValueType.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasAllEqualStates For the purposes of this test, Selected and SelectedPersistent are considered equal.
Public method HasNoEqualStates For the purposes of this test, Selected and SelectedPersistent are considered equal.
Public method HasSomeEqualStates For the purposes of this test, Selected and SelectedPersistent are considered equal.
Public method ToString Provides a string representation of this ComponentStatus. (Overrides ValueType.ToString().)
Public method WithStates Activates any information flag described in any of the two input component statuses and returns a new ComponentStatus with those flags checked.
  Back to Top

Operators

 

Name Description
Public operatorStatic member Addition Sets flags from both component states and returns a new ComponentStatus.
Public operatorStatic member Equality Determines if two ComponentStatus objects are equal.
Public operatorStatic member Inequality Determines if two ComponentStatus objects differ.
  Back to Top

Version Information

Supported in: 6.0.16224.21491

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️