Component (Solibri Model Checker API 9.10.2 API)

All Known Subinterfaces:

Door, Opening, Ramp, Space, Stair, Wall, Window
```
public interface Component
```
Represents one component in the data model. A component has a unique identifier: UUID. It also has another UUID called the Model UUID to determine to which (sub) model it belongs. Additionally it can have any number of properties that are identified by their name.

Since:

9.10.2

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<Double>`	`distance(Component other)` Returns the minimum 3d distance between the surfaces of this `Component` and another, if it exists.
`Optional<Double>`	`distance(Vector3d point)` Returns the minimum 3d distance between the surface of this `Component` and a given point, if it exists.
`boolean`	`equals(Object object)` Returns true if the components are equal.
`AABB3d`	`getBoundingBox()` Calculates the axis-aligned bounding box for this component.
`ComponentType`	`getComponentType()` Returns the `ComponentType` of the entity.
`Footprint`	`getFootprint()` Returns the footprint for this component.
`String`	`getGUID()` Returns the GUID of this component specified in IFC.
`Set<Intersection>`	`getIntersections(Component component)` Returns the intersections of this component and given component.
`String`	`getName()` Returns the name of this component.
`Collection<PropertySet>`	`getPropertySets()` Returns the property sets of this component.
`Collection<PropertySet>`	`getPropertySets(String name)` Returns the property sets of this component with the given name.
`<T> Optional<T>`	`getPropertyValue(PropertyReference propertyReference)` Returns the value of property to which the given PropertyReference refers.
`Collection<Component>`	`getRelated(Relation relation)` Returns the components that are related to this component through the given relation.
`TriangleMesh`	`getTriangleMesh()` Returns the `TriangleMesh` composed of the triangles of this component and its decomposed components.
`Optional<Double>`	`horizontalDistance(Component other)` Returns the horizontal distance between the surfaces of this `Component` and another, if it exists.
`Optional<Double>`	`horizontalDistance(Vector3d point)` Returns the horizontal distance between the surface of this `Component` and a point, if it exists.
`Optional<Double>`	`projectionOnXYPlaneDistance(Component other)` Returns the 2d distance between the projections of this `Component` and another on the XY-plane, if it exists.
`Optional<Double>`	`projectionOnXYPlaneDistance(Vector3d other)` Returns the 2d distance between the projections of this `Component` and point on the XY-plane, if it exists.
`Optional<Double>`	`verticalDistance(Component other)` Returns the vertical distance between the surfaces of this `Component` and another, if it exists.
`Optional<Double>`	`verticalDistance(Vector3d point)` Returns the vertical distance between the surface of this `Component` and a point, if it exists.

- Method Detail
  - getComponentType
```
ComponentType getComponentType()
```
    Returns the ComponentType of the entity.
    
    Returns:
    
    the type of the entity
    
    Since:
    
    9.10.2
  - getGUID
```
String getGUID()
```
    Returns the GUID of this component specified in IFC.
    
    Returns:
    
    the GUID of this component specified in IFC
    
    Since:
    
    9.10.2
  - equals
```
boolean equals(Object object)
```
    Returns true if the components are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - the other component
    
    Returns:
    
    true if the components are equal
    
    Since:
    
    9.10.2
  - getPropertySets
```
Collection<PropertySet> getPropertySets()
```
    Returns the property sets of this component.
    
    Returns:
    
    the property sets of this component
    
    Since:
    
    9.10.2
  - getPropertySets
```
Collection<PropertySet> getPropertySets(String name)
```
    Returns the property sets of this component with the given name.
    
    Parameters:
    
    name - the name of the property set
    
    Returns:
    
    the property sets of this component with the given name
    
    Since:
    
    9.10.2
  - getPropertyValue
```
<T> Optional<T> getPropertyValue(PropertyReference propertyReference)
```
    Returns the value of property to which the given PropertyReference refers. If this entity does not contain the property to which the reference refers or if the property value is not of the given type, then returns empty.
    
    Type Parameters:
    
    T - the expected type of the property value
    
    Parameters:
    
    propertyReference - reference to the property whose value is returned if present
    
    Returns:
    
    the value of the property to which the given PropertyReference refers
  - getTriangleMesh
```
TriangleMesh getTriangleMesh()
```
    Returns the TriangleMesh composed of the triangles of this component and its decomposed components.
    
    Returns:
    
    the TriangleMesh of this component and its decomposed components.
  - getBoundingBox
```
AABB3d getBoundingBox()
```
    Calculates the axis-aligned bounding box for this component.
    
    Returns:
    
    the axis-aligned bounding box
  - getFootprint
```
Footprint getFootprint()
```
    Returns the footprint for this component.
    
    Returns:
    
    the footprint for this component
  - getRelated
```
Collection<Component> getRelated(Relation relation)
```
    Returns the components that are related to this component through the given relation.
    
    Parameters:
    
    relation - the relation through which the returned components are related to this component
    
    Returns:
    
    the components that are related to this component through the given relation
    
    Since:
    
    9.10.2
  - getName
```
String getName()
```
    Returns the name of this component.
    The returned name is a short displayable name that describes the type of the component.
    
    Returns:
    
    the name of this component
    
    Since:
    
    9.10.2
  - getIntersections
```
Set<Intersection> getIntersections(Component component)
```
    Returns the intersections of this component and given component.
    
    Parameters:
    
    component - a component whose intersections with this component are to be calculated
    
    Returns:
    
    a set of intersections between this component and given component
    
    Since:
    
    9.10.2
    
    See Also:
    
    Intersection
  - distance
```
Optional<Double> distance(Vector3d point)
```
    Returns the minimum 3d distance between the surface of this Component and a given point, if it exists. If the point is inside the component, the distance will be from the point to the inner surface of the component. To check if a point is inside a component instead, use TriangleMesh.encloses(Vector3d) on the mesh obtained via getTriangleMesh().
    
    Parameters:
    
    point - the given point as Vector3d
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - distance
```
Optional<Double> distance(Component other)
```
    Returns the minimum 3d distance between the surfaces of this Component and another, if it exists. If the other component is inside the component, the distance will be from the inner component to the inner surface of the outer component.
    
    Parameters:
    
    other - the other Component
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - horizontalDistance
```
Optional<Double> horizontalDistance(Vector3d point)
```
    Returns the horizontal distance between the surface of this Component and a point, if it exists. If the point is inside the component, the distance will be from the point to the inner surface of the component.
    
    Parameters:
    
    point - the point as Vector3d
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - horizontalDistance
```
Optional<Double> horizontalDistance(Component other)
```
    Returns the horizontal distance between the surfaces of this Component and another, if it exists. If the other component is inside the component, the distance will be from the inner component to the inner surface of the outer component.
    
    Parameters:
    
    other - the other Component
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - verticalDistance
```
Optional<Double> verticalDistance(Vector3d point)
```
    Returns the vertical distance between the surface of this Component and a point, if it exists. If the point is inside the component, the distance will be from the point to the inner surface of the component.
    
    Parameters:
    
    point - the point as Vector3d
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - verticalDistance
```
Optional<Double> verticalDistance(Component other)
```
    Returns the vertical distance between the surfaces of this Component and another, if it exists. If the other component is inside the component, the distance will be from the inner component to the inner surface of the outer component.
    
    Parameters:
    
    other - the other Component
    
    Returns:
    
    the distance, if it exists
    
    Since:
    
    9.10.2
  - projectionOnXYPlaneDistance
```
Optional<Double> projectionOnXYPlaneDistance(Vector3d other)
```
    Returns the 2d distance between the projections of this Component and point on the XY-plane, if it exists.
    
    Parameters:
    
    other - point the point as Vector3d
    
    Returns:
    
    the distance on the XY-plane, if it exists
    
    Since:
    
    9.10.2
  - projectionOnXYPlaneDistance
```
Optional<Double> projectionOnXYPlaneDistance(Component other)
```
    Returns the 2d distance between the projections of this Component and another on the XY-plane, if it exists.
    
    Parameters:
    
    other - the other Component
    
    Returns:
    
    the distance on the XY-plane, if it exists
    
    Since:
    
    9.10.2

Interface Component

Method Summary

Method Detail

getComponentType

getGUID

equals

getPropertySets

getPropertySets

getPropertyValue

getTriangleMesh

getBoundingBox

getFootprint

getRelated

getName

getIntersections

distance

distance

horizontalDistance

horizontalDistance

verticalDistance

verticalDistance

projectionOnXYPlaneDistance

projectionOnXYPlaneDistance