Donner 0.8.0-pre
Embeddable browser-grade SVG2 engine
Loading...
Searching...
No Matches
donner::svg::SVGLineElement Class Reference

DOM object for a "<line>" element. More...

#include "donner/svg/SVGLineElement.h"

Inheritance diagram for donner::svg::SVGLineElement:
[legend]
Collaboration diagram for donner::svg::SVGLineElement:
[legend]

Public Member Functions

void setX1 (Lengthd value)
 Set the start X coordinate.
void setY1 (Lengthd value)
 Set the start Y coordinate.
void setX2 (Lengthd value)
 Set the end X coordinate.
void setY2 (Lengthd value)
 Set the end Y coordinate.
Lengthd x1 () const
 Get the start X coordinate.
Lengthd y1 () const
 Get the start Y coordinate.
Lengthd x2 () const
 Get the end X coordinate.
Lengthd y2 () const
 Get the end Y coordinate.
Public Member Functions inherited from donner::svg::SVGGeometryElement
double computedPathLength () const
 Get the length of the path in user units. To override this value for stroke-dasharray and other path-offset-relative values, use setPathLength.
std::optional< double > pathLength () const
 Get the path length override, if set. To get the computed path length, use computedPathLength().
void setPathLength (std::optional< double > value)
 Set the path length override.
std::optional< PathcomputedSpline () const
 Get the computed path geometry as a Path — a sequence of line segments, quadratic and cubic Bezier curves that define the shape's outline.
std::optional< Box2dworldBounds () const
 Get the bounding box of the element, in world coordinates.
Public Member Functions inherited from donner::svg::SVGGraphicsElement
Transform2d transform () const
 Get the 2d transformation for this element, element-from-parent.
void setTransform (const Transform2d &transform)
 Set the 2d transformation for this element, element-from-parent. This is a no-op if the transform is identity.
Transform2d elementFromWorld () const
 Get the absolute element-from-world transform for this element.
Public Member Functions inherited from donner::svg::SVGElement
 SVGElement (const SVGElement &other)
 Create another reference to the same SVGElement.
 SVGElement (SVGElement &&other) noexcept
 Move constructor.
 ~SVGElement () noexcept
 Destructor.
SVGElementoperator= (const SVGElement &other)
 Create another reference to the same SVGElement.
SVGElementoperator= (SVGElement &&other) noexcept
 Move assignment operator.
ElementType type () const
 Get the ElementType for known XML element types.
std::optional< ElementTypetryType () const
 Get the ElementType if this handle still has SVG element identity.
xml::XMLQualifiedNameRef tagName () const
 Get the XML tag name string for this element.
std::optional< xml::XMLQualifiedNameReftryTagName () const
 Get the XML tag name if this handle still has XML tree identity.
bool isKnownType () const
 Returns true if this is a known element type, returns false if this is an donner::svg::SVGUnknownElement.
EntityHandle unsafeEntityHandle () const
 Get the underlying donner::EntityHandle.
EntityHandle entityHandle () const
 Get the underlying donner::EntityHandle, for advanced use-cases that require direct access to the ECS.
template<typename Callback>
decltype(auto) withReadAccess (Callback &&callback) const
 Run a callback with scoped read access to this element's document and resolved entity handle.
template<typename Callback>
decltype(auto) withWriteAccess (Callback &&callback) const
 Run a callback with scoped write access to this element's document and resolved entity handle.
RcString id () const
 Get the element id, the value of the "id" attribute.
void setId (std::string_view id)
 Set the element id, the value of the "id" attribute.
RcString className () const
 Get the element class name, the value of the "class" attribute.
void setClassName (std::string_view name)
 Set the element class name, the value of the "class" attribute.
void setStyle (std::string_view style)
 Set the element style, the value of the "style" attribute.
void updateStyle (std::string_view style)
 Update the element style, adding new attributes or overridding existing ones (without removing them).
ParseResult< bool > trySetPresentationAttribute (std::string_view name, std::string_view value)
 Set the value of a presentation attribute, such as "fill" or "stroke".
bool hasAttribute (const xml::XMLQualifiedNameRef &name) const
 Returns true if the element has an attribute with the given name.
std::optional< RcStringgetAttribute (const xml::XMLQualifiedNameRef &name) const
 Get the value of an attribute, if it exists.
SmallVector< xml::XMLQualifiedNameRef, 1 > findMatchingAttributes (const xml::XMLQualifiedNameRef &matcher) const
 Find attributes matching the given name matcher.
SmallVector< xml::XMLQualifiedNameRef, 10 > attributes () const
 Get the list of attributes for this element.
void setAttribute (const xml::XMLQualifiedNameRef &name, std::string_view value)
 Set the value of a generic XML attribute, which may be either a presentation attribute or custom user-provided attribute.
void removeAttribute (const xml::XMLQualifiedNameRef &name)
 Remove an attribute, which may be either a presentation attribute or custom user-provided attribute.
SVGDocument ownerDocument ()
 Get an owning reference to the SVGDocument containing this element.
std::optional< SVGElementparentElement () const
 Get this element's parent, if it exists.
std::optional< SVGElementfirstChild () const
 Get the first child of this element, if it exists.
std::optional< SVGElementlastChild () const
 Get the last child of this element, if it exists.
std::optional< SVGElementpreviousSibling () const
 Get the previous sibling of this element, if it exists.
std::optional< SVGElementnextSibling () const
 Get the next sibling of this element, if it exists.
void insertBefore (const SVGElement &newNode, std::optional< SVGElement > referenceNode)
 Insert newNode as a child, before referenceNode.
void appendChild (const SVGElement &child)
 Append child as a child of the current node.
void replaceChild (const SVGElement &newChild, const SVGElement &oldChild)
 Replace oldChild with newChild in the tree, removing oldChild and inserting newChild in its place.
void removeChild (const SVGElement &child)
 Remove child from this node.
void remove ()
 Remove this node from its parent, if it has one.
bool operator== (const SVGElement &other) const
 Returns true if the two SVGElement handles reference the same underlying document.
bool operator!= (const SVGElement &other) const
 Returns true if the two SVGElement handles reference the same underlying document.
template<typename Derived>
bool isa () const
 Return true if this element "is a" instance of type, if it be cast to a specific type with cast.
template<typename Derived>
Derived cast ()
 Cast this element to its derived type.
template<typename Derived>
Derived cast () const
 Cast this element to its derived type (const version).
template<typename Derived>
std::optional< Derived > tryCast ()
 Cast this element to its derived type, if possible.
template<typename Derived>
std::optional< const Derived > tryCast () const
 Cast this element to its derived type, if possible.
std::optional< SVGElementquerySelector (std::string_view selector)
 Find the first element in the tree that matches the given CSS selector.
const PropertyRegistrygetComputedStyle () const
 Get the computed CSS style of this element, after the CSS cascade has been applied.

Static Public Member Functions

static SVGLineElement Create (SVGDocument &document)
 Create a new "<line>" element.
Static Public Member Functions inherited from donner::svg::SVGGeometryElement
static constexpr bool IsBaseOf (ElementType type)
 Returns true if the given element type can be cast to SVGGeometryElement.
Static Public Member Functions inherited from donner::svg::SVGGraphicsElement
static constexpr bool IsBaseOf (ElementType type)
 Returns true if the given element type can be cast to SVGTextContentElement.

Static Public Attributes

static constexpr ElementType Type = ElementType::Line
 Element type.
static constexpr std::string_view Tag {"line"}
 XML tag name, "<line>".

Protected Member Functions

 SVGLineElement (EntityHandle handle)
 Create an SVGLineElement wrapper from an entity.
Protected Member Functions inherited from donner::svg::SVGGeometryElement
 SVGGeometryElement (EntityHandle handle)
 Internal constructor to create an SVGGeometryElement from an EntityHandle.
void invalidate ()
 Invalidates the computed shape for this element, should be called when the shape geometry changes.
Protected Member Functions inherited from donner::svg::SVGGraphicsElement
 SVGGraphicsElement (EntityHandle handle)
 Inheriting constructor to be called by derived classes. SVGGraphicsElement cannot be instantiated directly.
Protected Member Functions inherited from donner::svg::SVGElement
 SVGElement (EntityHandle handle)
 Internal constructor to create an SVGElement from an donner::EntityHandle.
template<typename InvalidateCallback>
ScopedMutation< std::decay_t< InvalidateCallback > > mutationScope (InvalidateCallback &&invalidateOnScopeExit) const
 Create a scoped mutation that runs invalidateOnScopeExit before the revision commit.
std::optional< ParseDiagnosticsetAttributeFromXMLMutation (const xml::XMLQualifiedNameRef &name, std::string_view value)
 Set an attribute from an XML mutation and return any SVG semantic parse diagnostic.
void removeAttributeFromXMLMutation (const xml::XMLQualifiedNameRef &name)
 Remove an attribute from an XML mutation without writing back to XML source.
RegistryunsafeRegistry () const
 Get the underlying ECS Registry, which holds all data for the document, for advanced use.
Registryregistry () const
 Get the underlying ECS Registry, which holds all data for the document, for advanced use.
EntityHandle toHandle (Entity entity) const
 Convert an Entity to an EntityHandle, for advanced use.

Static Protected Member Functions

static SVGLineElement CreateOn (EntityHandle handle)
 Internal constructor to create the element on an existing Entity.
Static Protected Member Functions inherited from donner::svg::SVGElement
static DocumentWriteAccess CreateElementWriteAccess (SVGDocument &document)
 Acquire write access for creating an element in a document.
static DocumentMutationBatch CreateElementMutationBatch (SVGDocument &document)
 Acquire a mutation scope for creating an element in a document.
static EntityHandle CreateEmptyEntity (SVGDocument &document)
 Create a new Entity within the document ECS, and return a handle to it.
static EntityHandle CreateEmptyEntity (DocumentWriteAccess &access)
 Create a new Entity within a guarded document ECS, and return a handle to it.
static void CreateEntityOn (EntityHandle handle, const xml::XMLQualifiedNameRef &tagName, ElementType Type)
 Create a new SVG element instance on a given donner::Entity.

Friends

class parser::SVGParserImpl

Additional Inherited Members

Protected Attributes inherited from donner::svg::SVGElement
ElementAnchor handle_
 The lifetime-aware ECS entity anchor for this element.

Detailed Description

DOM object for a "<line>" element.

Use the x1, y1, x2, and y2 attributes to define the start and end of the line.

x1,y1 x2,y2

Member Function Documentation

◆ Create()

SVGLineElement donner::svg::SVGLineElement::Create ( SVGDocument & document)
inlinestatic

Create a new "<line>" element.

Parameters
documentContaining document.

◆ CreateOn()

SVGLineElement donner::svg::SVGLineElement::CreateOn ( EntityHandle handle)
staticprotected

Internal constructor to create the element on an existing Entity.

Parameters
handleEntity handle.

◆ setX1()

void donner::svg::SVGLineElement::setX1 ( Lengthd value)

Set the start X coordinate.

Parameters
valueCoordinate value.

◆ setX2()

void donner::svg::SVGLineElement::setX2 ( Lengthd value)

Set the end X coordinate.

Parameters
valueCoordinate value.

◆ setY1()

void donner::svg::SVGLineElement::setY1 ( Lengthd value)

Set the start Y coordinate.

Parameters
valueCoordinate value.

◆ setY2()

void donner::svg::SVGLineElement::setY2 ( Lengthd value)

Set the end Y coordinate.

Parameters
valueCoordinate value.

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