[#mp_units-relative_point_origin]
= xref:mp_units.adoc[mp_units]::relative_point_origin
:relfileprefix: ../
:mrdocs:

A point origin defined relative to another quantity point

== Synopsis

Declared in `<mp‐units/framework/quantity_point.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/QuantityPoint.adoc[QuantityPoint] auto QP,
    auto Args...>
struct relative_point_origin;
----

== Description

Its absolute origin is the absolute origin of `QP`, and it is displaced from that absolute origin by the value of `QP` itself, which allows users to define new origins in terms of previously defined quantity points.

== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/relative_point_origin/_absolute_point_origin_.adoc[`_absolute_point_origin_`] 
| The absolute point origin that `QP`, and thus this origin, is ultimately measured from
| xref:mp_units/relative_point_origin/_bounds_.adoc[`_bounds_`] 
| The bounds policy applied to points measured from this origin, if any was provided in `Args`
| xref:mp_units/relative_point_origin/_quantity_point_.adoc[`_quantity_point_`] 
| The quantity point this origin is defined relative to
| xref:mp_units/relative_point_origin/_quantity_spec_.adoc[`_quantity_spec_`] 
| The quantity specification of this origin, being the strongest of `QP`'s specs
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mp_units/get_quantity_spec-05.adoc[`get_quantity_spec`]
| 
| xref:mp_units/operator_plus-00.adoc[`operator+`]
| Addition operator
| xref:mp_units/operator_plus-03.adoc[`operator+`]
| Addition operator
| xref:mp_units/operator_minus-02.adoc[`operator‐`]
| Subtraction operator
| xref:mp_units/operator_minus-03a.adoc[`operator‐`]
| Subtraction operator
|===

== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *QP*
| the quantity point this origin is defined relative to
| *Args*
| optional policy arguments (e.g. a bounds policy)
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#