donner::svg::components::SVGDocumentContext Class Reference

Holds global state of an SVG document, such as the root element, id-to-element mapping, and the document size. More...

#include "donner/svg/components/SVGDocumentContext.h"

Public Member Functions
	SVGDocumentContext (InternalCtorTag ctorTag, const std::shared_ptr< Registry > &registry)
	Internal constructor, creates a context on the given SVGDocument.
Entity	getEntityById (const RcString &id) const
	Get the entity with the given ID, using the internal id-to-entity mapping.

Public Attributes
std::optional< Vector2i >	canvasSize
	Current canvas size, if set. Equivalent to the window size, which controls how the SVG contents are rendered.
Entity	rootEntity = entt::null
	Root entity of the document, which contains the "<svg>" element.

Friends
class	::donner::svg::SVGDocument
class	::donner::svg::SVGElement

Detailed Description

Holds global state of an SVG document, such as the root element, id-to-element mapping, and the document size.

One instance of this class is created per SVG document.

Access the document context via the Registry::ctx API:

SVGDocumentContext& context = registry.ctx().get<SVGDocumentContext>();
Entity foo = context.getEntityById("foo");

Constructor & Destructor Documentation

SVGDocumentContext()

donner::svg::components::SVGDocumentContext::SVGDocumentContext ( InternalCtorTag ctorTag, const std::shared_ptr< Registry > & registry )

explicit

Internal constructor, creates a context on the given SVGDocument.

To use this class, access it via the Registry::ctx API.

SVGDocumentContext& context = registry.ctx().get<SVGDocumentContext>();

Parameters

ctorTag	Internal tag to allow construction.
registry	Underlying registry for the document.

Member Function Documentation

getEntityById()

Entity donner::svg::components::SVGDocumentContext::getEntityById ( const RcString & id ) const

inline

Get the entity with the given ID, using the internal id-to-entity mapping.

If multiple elements have the same id, the first one that was created will be returned.

Parameters

id	ID to find the entity for.

---

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

• donner/svg/components/SVGDocumentContext.h
• donner/svg/components/SVGDocumentContext.cc