ComponentIndex

References
Represents an index of an element contained in another object.

Constructors

ComponentIndex

#Since v5.0
Construct component index with a specific type/index combination
public ComponentIndex()

Properties

ComponentIndexType

#Since v5.0
The interpretation of Index depends on the Type value. Type m_index interpretation (0 based indices) no_type used when context makes it clear what array is being index brep_vertex Brep.m_V[] array index brep_edge Brep.m_E[] array index brep_face Brep.m_F[] array index brep_trim Brep.m_T[] array index brep_loop Brep.m_L[] array index mesh_vertex Mesh.m_V[] array index meshtop_vertex MeshTopology.m_topv[] array index meshtop_edge MeshTopology.m_tope[] array index mesh_face Mesh.m_F[] array index idef_part InstanceDefinition.m_object_uuid[] array index polycurve_segment PolyCurve::m_segment[] array index dim_linear_point LinearDimension2::POINT_INDEX dim_radial_point RadialDimension2::POINT_INDEX dim_angular_point AngularDimension2::POINT_INDEX dim_ordinate_point OrdinateDimension2::POINT_INDEX dim_text_point TextEntity2 origin point.
public ComponentIndexType ComponentIndexType { get; }

Index

#Since v5.0
The interpretation of m_index depends on the m_type value. m_type m_index interpretation (0 based indices) no_type used when context makes it clear what array is being index brep_vertex Brep.m_V[] array index brep_edge Brep.m_E[] array index brep_face Brep.m_F[] array index brep_trim Brep.m_T[] array index brep_loop Brep.m_L[] array index mesh_vertex Mesh.m_V[] array index meshtop_vertex MeshTopology.m_topv[] array index meshtop_edge MeshTopology.m_tope[] array index mesh_face Mesh.m_F[] array index idef_part InstanceDefinition.m_object_uuid[] array index polycurve_segment PolyCurve::m_segment[] array index dim_linear_point LinearDimension2::POINT_INDEX dim_radial_point RadialDimension2::POINT_INDEX dim_angular_point AngularDimension2::POINT_INDEX dim_ordinate_point OrdinateDimension2::POINT_INDEX dim_text_point TextEntity2 origin point.
public int Index { get; }

IsSet

#Since v8.26
public bool IsSet { get; }

Unset

#Since v5.0
The unset value of component index.
public static ComponentIndex Unset { get; }

Methods

CompareTo

#Since v8.0
Compares this ComponentIndex with another ComponentIndex.
public int CompareTo(
other
The other ComponentIndex to use in comparison
)

0: if this is identical to other

-1: if this.ComponentIndexType < other.ComponentIndexType

-1: if this.ComponentIndexType == other.ComponentIndexType and this.Index < other.Index

+1: otherwise.

Equals

#Since v8.0
Determines whether the specified ComponentIndex is equal to the current ComponentIndex, comparing by value.
public bool Equals(
other
The other ComponentIndex to compare with.
)
true if other has the same ComponentIndexType and Index as this; otherwise, false.

Equals

#Since v8.0
Determines whether the specified object is equal to the current ComponentIndex, comparing by value.
public override bool Equals(
obj
The other object to compare with.
)
true if obj is a ComponentIndex and ComponentIndexType and Index is the same; false otherwise.
ValueType.Equals

GetHashCode

#Since v8.0
Computes the hash code for this ComponentIndex object.
public override int GetHashCode()
A hash value that might be equal for two different ComponentIndex values.

IsUnset

#Since v7.0
Return true is this component index is the same as the Unset component index
public bool IsUnset()

Operators

OperationResultDescription
ComponentIndex==ComponentIndexboolDetermines whether two ComponentIndexes have equal values.
ComponentIndex>ComponentIndexboolDetermines whether the first ComponentIndex comes after the second.
ComponentIndex>=ComponentIndexboolDetermines whether the first ComponentIndex comes after the second, or it is equal to it.
ComponentIndex!=ComponentIndexboolDetermines whether two ComponentIndexes have different values.
ComponentIndex<ComponentIndexboolDetermines whether the first ComponentIndex comes before the second.
ComponentIndex<=ComponentIndexboolDetermines whether the first ComponentIndex comes before the second, or it is equal to it.