Struct Angle

pub struct Angle(/* private fields */);

An angle describing a rotation.

Typst supports the following angular units:

• Degrees: {180deg}
• Radians: {3.14rad}

Example

#rotate(10deg)[Hello there!]

Implementations

impl Angle

pub const fn zero() -> Angle

The zero angle.

pub const fn raw(raw: f64) -> Angle

Create an angle from a number of raw units.

pub fn with_unit(val: f64, unit: AngleUnit) -> Angle

Create an angle from a value in a unit.

pub fn rad(rad: f64) -> Angle

Create an angle from a number of radians.

pub fn deg(deg: f64) -> Angle

Create an angle from a number of degrees.

pub const fn to_raw(self) -> f64

Get the value of this angle in raw units.

pub fn to_unit(self, unit: AngleUnit) -> f64

Get the value of this angle in a unit.

pub fn abs(self) -> Angle

The absolute value of the this angle.

pub fn sin(self) -> f64

Get the sine of this angle in radians.

pub fn cos(self) -> f64

Get the cosine of this angle in radians.

pub fn tan(self) -> f64

Get the tangent of this angle in radians.

pub fn quadrant(self) -> Quadrant

Get the quadrant of the Cartesian plane that this angle lies in.

The angle is automatically normalized to the range 0deg..=360deg.

The quadrants are defined as follows:

• First: 0deg..=90deg (top-right)
• Second: 90deg..=180deg (top-left)
• Third: 180deg..=270deg (bottom-left)
• Fourth: 270deg..=360deg (bottom-right)

impl Angle

pub fn to_rad(self) -> f64

Converts this angle to radians.

pub fn to_deg(self) -> f64

Converts this angle to degrees.

Trait Implementations

impl Add for Angle

type Output = Angle

The resulting type after applying the + operator.

fn add(self, other: Angle) -> Angle

Performs the + operation.

impl AddAssign for Angle

fn add_assign(&mut self, other: Angle)

Performs the += operation.

impl Clone for Angle

fn clone(&self) -> Angle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Angle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Angle

fn default() -> Angle

Returns the “default value” for a type.

impl Div<f64> for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, other: f64) -> Angle

Performs the / operation.

impl Div for Angle

type Output = f64

The resulting type after applying the / operator.

fn div(self, other: Angle) -> f64

Performs the / operation.

impl DivAssign<f64> for Angle

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl FromValue for Angle

fn from_value(value: Value) -> Result<Angle, HintedString>

Try to cast the value into an instance of Self.

impl Hash for Angle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Angle

fn into_value(self) -> Value

Cast this type into a value.

impl Mul<f64> for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Angle

Performs the * operation.

impl MulAssign<f64> for Angle

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl NativeScope for Angle

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Angle

const NAME: &'static str = "angle"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Angle

Performs the unary - operation.

impl Numeric for Angle

fn zero() -> Angle

The identity element for addition.

fn is_finite(self) -> bool

Whether self consists only of finite parts.

fn is_zero(self) -> bool

Whether self is zero.

impl Ord for Angle

fn cmp(&self, other: &Angle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Angle

fn eq(&self, other: &Angle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Angle

fn partial_cmp(&self, other: &Angle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for Angle

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Angle

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Sub for Angle

type Output = Angle

The resulting type after applying the - operator.

fn sub(self, other: Angle) -> Angle

Performs the - operation.

impl SubAssign for Angle

fn sub_assign(&mut self, other: Angle)

Performs the -= operation.

impl Sum for Angle

fn sum<I>(iter: I) -> Angle

where I: Iterator<Item = Angle>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Angle

impl Eq for Angle

impl StructuralPartialEq for Angle