ComponentStatus

ComponentStatus struct

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

Namespace: Rhino.Geometry
ComponentStatus: references

Properties (15)

AllSet

All flags are checked.

Clear

This is the default value and equal to undefined.

Damaged

The damaged flag is checked.

Hidden

The hidden flag is checked.

Highlighted

The highlight selection flag is checked.

IsClear

True if every setting is 0 or false.

IsDamaged

Returns False if component is not damaged. True otherwise.

IsHidden

Returns True if hidden. False otherwise.

IsHighlighted

Returns True if highlighted. False otherwise.

IsLocked

Returns True if locked. False otherwise.

IsSelected

Returns True if selected or selected persistent. False otherwise.

IsSelectedPersistent

Returns True if selected persistent. False otherwise.

Locked

The locked flag is checked.

Selected

The selection flag is checked.

SelectedPersistent

The persistent selection flag is checked.

Methods (8)

Equals(ComponentStatus other)

Determines if another ComponentStatus and this are equal.

Equals(Object obj)

Determines if an object and this are equal.

GetHashCode()

Serves as a special hash function. The inner value is used for the purpose.

HasAllEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)

For the purposes of this test, Selected and SelectedPersistent are considered equal.

HasNoEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)

For the purposes of this test, Selected and SelectedPersistent are considered equal.

HasSomeEqualStates(ComponentStatus statesFilter, ComponentStatus comparand)

For the purposes of this test, Selected and SelectedPersistent are considered equal.

ToString()

Provides a string representation of this ComponentStatus.

WithStates(ComponentStatus additionalStatus)

Activates any information flag described in any of the two input component statuses and returns a new ComponentStatus with those flags checked.

Operators (3)

Determines if two ComponentStatus objects differ.

Sets flags from both component states and returns a new ComponentStatus.

Determines if two ComponentStatus objects are equal.

Nothing found