Handles SVG's preserveAspectRatio attribute. More...

#include "donner/svg/core/PreserveAspectRatio.h"

Public Types
enum class	Align : uint8_t { None , XMinYMin , XMidYMin , XMaxYMin , XMinYMid , XMidYMid , XMaxYMid , XMinYMax , XMidYMax , XMaxYMax }
	Alignment options for preserveAspectRatio. More...
enum class	MeetOrSlice : uint8_t { Meet , Slice }
	Scaling methods for preserveAspectRatio. More...

Public Member Functions
double	alignMultiplierX () const
	Calculates the horizontal alignment factor.
double	alignMultiplierY () const
	Calculates the vertical alignment factor.
Transformd	elementContentFromViewBoxTransform (const Boxd &size, std::optional< Boxd > viewBox) const
	Computes the transformation in destinationFromSource notation that maps coordinates from the viewBox coordinate system (source) to the element's content coordinate system (destination).
bool	operator== (const PreserveAspectRatio &other) const
	Equality operator.

Static Public Member Functions
static PreserveAspectRatio	Default ()
	Create a default PreserveAspectRatio from the SVG2 spec, which is XMidYMid meet.
static PreserveAspectRatio	None ()
	Creates a PreserveAspectRatio with 'none' alignment.

Public Attributes
Align	align = Align::XMidYMid
	Default: XMidYMid per SVG spec.
MeetOrSlice	meetOrSlice = MeetOrSlice::Meet
	Default: Meet per SVG spec.

Friends
std::ostream &	operator<< (std::ostream &os, const PreserveAspectRatio &value)
	Outputs a string representation of PreserveAspectRatio to a stream.

Detailed Description

Handles SVG's preserveAspectRatio attribute.

Member Enumeration Documentation

◆ Align

enum class donner::svg::PreserveAspectRatio::Align : uint8_t

strong

Alignment options for preserveAspectRatio.

Enumerator
None	No forced uniform scaling.
XMinYMin	Left-top alignment.
XMidYMin	Center-top alignment.
XMaxYMin	Right-top alignment.
XMinYMid	Left-center alignment.
XMidYMid	Center-center alignment.
XMaxYMid	Right-center alignment.
XMinYMax	Left-bottom alignment.
XMidYMax	Center-bottom alignment.
XMaxYMax	Right-bottom alignment.

◆ MeetOrSlice

enum class donner::svg::PreserveAspectRatio::MeetOrSlice : uint8_t

strong

Scaling methods for preserveAspectRatio.

Enumerator
Meet	Scale to fit within viewport.
Slice	Scale to cover entire viewport, clipping the content if necessary.

Member Function Documentation

◆ alignMultiplierX()

double donner::svg::PreserveAspectRatio::alignMultiplierX ( ) const

inline

Calculates the horizontal alignment factor.

Returns: 0 for left, 0.5 for center, 1 for right alignment.

◆ alignMultiplierY()

double donner::svg::PreserveAspectRatio::alignMultiplierY ( ) const

inline

Calculates the vertical alignment factor.

Returns: 0 for top, 0.5 for middle, 1 for bottom alignment.

◆ Default()

PreserveAspectRatio donner::svg::PreserveAspectRatio::Default ( )

inlinestatic

Create a default PreserveAspectRatio from the SVG2 spec, which is XMidYMid meet.

See also: https://www.w3.org/TR/SVG2/coords.html#PreserveAspectRatioAttribute

◆ elementContentFromViewBoxTransform()

Transformd donner::svg::PreserveAspectRatio::elementContentFromViewBoxTransform	(	const Boxd &	size,
		std::optional< Boxd >	viewBox ) const

Computes the transformation in destinationFromSource notation that maps coordinates from the viewBox coordinate system (source) to the element's content coordinate system (destination).

The size parameter represents the destination rectangle for the element's content, while the optional viewBox parameter defines the source coordinate system. If no viewBox is provided, the transformation is a simple translation to the top‐left of size.

See also: https://www.w3.org/TR/SVG2/coords.html#ComputingAViewportsTransform.

Parameters

size	The destination rectangle for the element's content.
viewBox	The source viewBox rectangle, if any.

Returns: The computed transformation mapping points from the viewBox (source) to the element's content (destination).

◆ None()

PreserveAspectRatio donner::svg::PreserveAspectRatio::None ( )

inlinestatic

Creates a PreserveAspectRatio with 'none' alignment.

Useful for scenarios where aspect ratio should be ignored.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const PreserveAspectRatio &	value )

friend

Outputs a string representation of PreserveAspectRatio to a stream.

Format: "PreserveAspectRatio {<align>, <meetOrSlice>}" Example: "PreserveAspectRatio {Align::XMidYMid, MeetOrSlice::Meet}"

The documentation for this class was generated from the following files:

donner/svg/core/PreserveAspectRatio.h
donner/svg/core/PreserveAspectRatio.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends