ostk.physics.environment.object.Geometry

class Geometry(*args, **kwargs)

Bases: pybind11_object

Geometry.

Overloaded function.

  1. __init__(self: ostk.physics.environment.object.Geometry, arg0: ostk.mathematics.geometry.d3.object.Composite, arg1: ostk.physics.coordinate.Frame) -> None

  2. __init__(self: ostk.physics.environment.object.Geometry, arg0: ostk.mathematics.geometry.d3.Object, arg1: ostk.physics.coordinate.Frame) -> None

Methods

access_composite

Access composite.

access_frame

Access frame.

contains

Check if the geometry contains a point.

in_frame

Get geometry expressed in a given frame.

intersection_with

Compute intersection of geometry with another geometry.

intersects

Check if the geometry intersects with another geometry.

is_defined

Check if the geometry is defined.

undefined

Constructs an undefined geometry.

access_composite(
self: ostk.physics.environment.object.Geometry,
) → ostk.mathematics.geometry.d3.object.Composite

Access composite.

Returns:

Composite.

Return type:

Composite

access_frame(
self: ostk.physics.environment.object.Geometry,
) → ostk.physics.coordinate.Frame

Access frame.

Returns:

Frame.

Return type:

Frame

contains(
self: ostk.physics.environment.object.Geometry,
arg0: ostk.physics.environment.object.Geometry,
) → bool

Check if the geometry contains a point.

Parameters:

aPoint (Point) -- A point.

Returns:

True if geometry contains point.

Return type:

bool

in_frame(
self: ostk.physics.environment.object.Geometry,
arg0: ostk.physics.coordinate.Frame,
arg1: ostk.physics.time.Instant,
) → ostk.physics.environment.object.Geometry

Get geometry expressed in a given frame.

Parameters:

  • aFrame (Frame) -- Frame.

  • anInstant (Instant) -- An instant.

Returns:

Geometry expressed in a given frame.

Return type:

Geometry

intersection_with(
self: ostk.physics.environment.object.Geometry,
arg0: ostk.physics.environment.object.Geometry,
) → ostk.physics.environment.object.Geometry

Compute intersection of geometry with another geometry.

Parameters:

aGeometry (Geometry) -- Another geometry.

Returns:

Intersection of geometry with another geometry.

Return type:

Geometry

intersects(
self: ostk.physics.environment.object.Geometry,
arg0: ostk.physics.environment.object.Geometry,
) → bool

Check if the geometry intersects with another geometry.

Parameters:

aGeometry (Geometry) -- Another geometry.

Returns:

True if geometries intersect.

Return type:

bool

is_defined(self: ostk.physics.environment.object.Geometry) → bool

Check if the geometry is defined.

Returns:

True if defined.

Return type:

bool

static undefined() → ostk.physics.environment.object.Geometry

Constructs an undefined geometry.

Returns:

Undefined geometry.

Return type:

Geometry