Acts::ExtentEnvelope Struct Reference

This struct models a multi-dimensional enveloper along the axis directions. More...

#include <Acts/Geometry/Extent.hpp>

Classes
struct	Arguments
	Helper struct for designated initializer construction. More...

Public Member Functions
constexpr	ExtentEnvelope (Arguments &&args)
	Constructor using a helper struct for designated initializaion.
	ExtentEnvelope (const Envelope &envelope=zeroEnvelope)
	Constructor from a single envelope that is assigned to all values.
Envelope &	operator[] (AxisDirection aDir)
	Access a single envelope configuration.
const Envelope &	operator[] (AxisDirection aDir) const
	Access a single envelope configuration.
ExtentEnvelope &	set (AxisDirection aDir, const Envelope &envelope)
	Setter that allows for method chaining.

Static Public Member Functions
static constexpr ExtentEnvelope	Zero ()
	Static factory for a zero envelope.

Detailed Description

This struct models a multi-dimensional enveloper along the axis directions.

Constructor & Destructor Documentation

ExtentEnvelope() [1/2]

Acts::ExtentEnvelope::ExtentEnvelope ( const Envelope & envelope = zeroEnvelope )

explicit

Constructor from a single envelope that is assigned to all values.

Parameters

envelope

the envelope to be assigned

ExtentEnvelope() [2/2]

Acts::ExtentEnvelope::ExtentEnvelope ( Arguments && args )

explicitconstexpr

Constructor using a helper struct for designated initializaion.

Parameters

args	the arguments

Member Function Documentation

operator[]() [1/2]

Envelope & Acts::ExtentEnvelope::operator[]

(

AxisDirection

aDir

)

Access a single envelope configuration.

Parameters

aDir	the axis definition

Returns

the envelope

operator[]() [2/2]

const Envelope & Acts::ExtentEnvelope::operator[]

(

AxisDirection

aDir

)

const

Access a single envelope configuration.

Parameters

aDir	the axis direction

Returns

the envelope

set()

ExtentEnvelope & Acts::ExtentEnvelope::set	(	AxisDirection	aDir,
		const Envelope &	envelope )

Setter that allows for method chaining.

Parameters

aDir	the axis direction
envelope	the envelope to be set

Returns

a reference to the envelope for chaining

Zero()

constexpr ExtentEnvelope Acts::ExtentEnvelope::Zero ( )

staticconstexpr

Static factory for a zero envelope.

Returns

the zero envelope