RiverSoftAVG Products Help

Create(TSVGDocument)

Initializes a new instance of the TSVGElement class.

Destroy

Represents the destructor of the TSVGElement class.

Attributes

Returns the valid style properties of the svg element

BoundsRect

Specifies the bounding rectangle (X, Y, X+Width, Y+Height) for the SVG element unmodified by any transformations in the current coordinate system.

The X, Y, Width, and Height properties specify coordinates in virtual pixels of the nearest viewbox, or coordinate system. For example, a TSVGDocument may specify a ViewBox of 0, 0, 100, 100. Specifying an element's X and Y as 50, 50 will always position the element to start in the exact center of the view box. If the TSVGDocument is then drawn to a true pixel rectangle of 1000 pixel width and 500 pixel height, the element would draw at 500, 250 pixels.

To retrieve the "true" bounding rectangle which has been modified by any transformations, use the GetBoundsRect method

The BoundsRect and X/Y/Width/Height properties specify coordinates in virtual pixels of the nearest viewbox, or coordinate system. For example, a TSVGDocument may specify a ViewBox of 0, 0, 100, 100. Specifying an element's X and Y as 50, 50 will always position the element to start in the exact center of the view box. If the TSVGDocument is then drawn to a true pixel rectangle of 1000 pixel width and 500 pixel height, the element would draw at 500, 250 pixels.

Classes

Specifies the 'classes' that the SVG element belongs to. The classes property assigns one or more class names to an element. The element may be said to belong to these classes. A class name may be shared by several element instances.

Description

Specifies a non-visual Description for the SVG element. When generating FMX controls, the FMX control's Hint property is set to the Description. If the Description is empty, the Hint is set to the Title

ElementState

Returns the state of the element. Use this property to correctly update the element when it is in a certain state.

Enabled

Specifies whether the element is enabled or disabled. By default, disabled elements are not exported or detected by the FMX.RS.SVG.TSVGElement.ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions) method.

Disabled elements are shown using a grayscale version of the element, which may be overridden with the OnDisableAppearance event.

ID

Unique name for the SVG element. The SVG document's   AllItems property uses the ID as the unique hash for returning SVG elements

Items

The child SVG Items of the current element. The Parent and Items properties define the hierarchy of a SVG document fragment.

Language

Specifies the Language of the SVG element

Listeners

Maintains the list of elements that need to be notified when this element changes or is being destroyed

When the current element changes, it will call the FMX.RS.SVG.TSVGElement.NotifyListener(TSVGElement) method of every element on this list

Options

Defines options for reading, displaying, and writing the svg.

The most important option as far as compatibility is the soUseFillText option. When this option is present, the RSCL uses FillText calls to directly render the text to the canvas. When this option is not present (default), the RSCL converts text into paths that are then filled and stroked. Converting text to paths provides the highest compatibility but slower performance. If you use the FMX GPU Canvas (FMX.Types.GlobalUseGPUCanvas), text is always filled and not converted to paths.

The following differences exist between the two text rendering paths:

• Fill Text does not use the Pen and so cannot both fill and stroke text

• Fill Text cannot use gradients for filling (FMX)

•ShapeRendering affects the smoothness of text when filling path-based text (as text are shapes); TextRendering affects the smoothness of text when filling text

• Fill Text uses less memory

• Fill Text generates better text at small sizes

• Path-based text caches its shapes so subsequent draw calls are faster, even faster than fill text calls in many cases

• Path-based text allows pixel level selection of text; Fill Text can only be selected as a text bounding box

• Path-based text renders decorative fonts (underline, overline, and strike-out) using an extra path for the decoration (FMX will not generate paths with the decoration when converting text to paths). Surprisingly, this means that compatibility is higher with path-based text as the decoration gets its rendering configuration from the parent text element (e.g., strike-out text should use the parent text's font size and not vary as the size of child text span's font size changes).

ApplyStyles

Applies all styles that match the element to the element. All child elements also have their styles applied.

Assign(TPersistent)

Represents method Assign(TPersistent).

AssignProperties(TPersistent)

Copies the properties of source to the current element (but not children)

AssignTo(TPersistent)

Represents method AssignTo(TPersistent).

BeforeDestruction

Represents method BeforeDestruction.

BeginUpdate

Marks the start of an update session of the element and its children.
 
No change events occur after the BeginUpdate call. A call to BeginUpdate must be complemented by calls to EndUpdate after the update is finished.
 
 

Change(TSVGElement)

Called when any property of the element changes

ChangeNotification(TSVGElement)

Ensures that aListener is notified that the element is going to be changed or destroyed. When the current element changes, it will call the aListener.NotifyListener method.

Use ChangeNotification when the aListener element must be notified when the current element changes. For example, the TSVGUse element uses this mechanism to know when to redraw because its Reference element has changed
 

ChildSVGTypes

Returns the set of allowable child SVG element types

Clear

Clears the SVG element and resets its properties back to their defaults

Clone(TSVGDocument)

Clones the element and all of its child elements. The aOwner parameter should be a different document

CreateControl(TControl)

Creates a TControl that best represents the svg element

CreateLength(TSVGLengthRangeEvent,TSVGUnitFactorsEvent)

Create a TSVGLength object and initializes its events to the parameter events

CreateLengths

Creates a TSVGLengths object list

DefineProperties(TFiler)

Represents method DefineProperties(TFiler).

DoLoadFromXML(IXMLNode)

This method sets the properties of the svg element from the node when loading the svg from XML

This method does the work for the current svg element only.

DoModifyControl(TControl,TSVGMatrix,TRSRect,TSVGControlElementEvent)

Modifies the TControl to make it appear like the current svg element

DoOnElementFound(TSVGGraphicElement)

This method is called when an SVG element is found at the specified position during an FMX.RS.SVG.TSVGElement.ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions) method call.

The method fires the OnElementFound event.

DoOnParsedNode(TSVGElement)

Called when an OnParsedNode event should fire (i.e., just after the node is parsed to set the properties of the svg element)

DoOnParsingNode(TSVGElement,IXMLNode)

Called when an OnParsingNode event should fire (i.e., just before the node is parsed to set the properties of the svg element)

DoOnSavedElement(TSVGElement,IXMLNode)

Called when an OnSavingElement event should fire (i.e., just after the svg element's properties are written to the node)

DoOnSavingElement(TSVGElement,IXMLNode)

Called when an OnSavingElement event should fire (i.e., just before the svg element's properties are written to the node)

DoSaveToXML(IXMLNode)

This method saves the properties of the svg element to the xml node.

This method does the work for the current svg element only.

DoShouldDraw

Represents method DoShouldDraw.

Draw(TSVGCanvas,TSVGRect)

Overloaded. Draw the SVG to the specified canvas inside the specified rectangle

ElementAtPos(TSVGCanvas,TSVGPoint,TSVGRect,TSVGFindOptions)

Returns the SVG element located at the specified position in the SVG. The method assumes the size and location of the current element is the rectangle specified by aRect. Use the ElementAtPos method to determine which SVG element is at the specified location in the current element.

If no SVG element is found at the specified location, the function returns nil

ElementNotification(TObject,TSVGElement,TCollectionNotification)

This method is called when an element is added or removed from the FMX.RS.SVG.TSVGElement.Items property

EnableChange

Called when the FMX.RS.SVG.TSVGElement.Enabled property changes

EndUpdate

Marks the end of an update session of the element and its children.
 
The update session must be started first by calling BeginUpdate.
 
EndUpdate decreases a updating semaphore. If all update sessions end and the semaphore is 0, EndUpdate signals a OnChange event.
 

FitToRect(TSVGRect)

Overloaded. Returns a transformation matrix that will properly scale and translate the SVG element's   BoundsRect so that it fits within the input rectangle

FitToRect(TSVGRect,TSVGRect)

Overloaded. Returns a transformation matrix that will properly scale and translate the TargetRect so that it fits within the input rectangle

GenerateChildControls(TControl,TSVGMatrix,TRSRect,TSVGControlElementEvent)

Generates the child controls for the current svg element based on the FMX.RS.SVG.TSVGElement.Items property

GenerateControls(TControl,TRSRect,TSVGControlElementEvent)

Overloaded.  Generates VCL/FMX controls to represent this SVG element and its children. The Parent parameter specifies the parent control for the generated VCL/FMX control.

The FMX control is transformed by a matrix returned from the GetViewMatrix function

GenerateControls(TControl,TSVGMatrix,TRSRect,TSVGControlElementEvent)

Overloaded. Generates VCL/FMX controls to represent this SVG element and its children. The Parent parameter specifies the parent control for the generated VCL/FMX control.

GetBoundsRect

Overloaded.  Returns the bounding rectangle for element made up of the X, Y, Width, and Height properties (at the FMX.RS.SVG.TSVGGraphicElement level) with no transformations applied. The values are the virtual "pixel" values using the nearest viewbox. For example, if the nearest viewbox (say the TSVGDocument specify a viewbox of 0, 0, 100, 100, a value of 50, 50 is exactly in the middle of the viewbox, regardless of the amount of pixels the TSVGDocument is being drawn to.

TSVGElement.GetBoundsRect returns an empty rectangle

GetBoundsRect(TSVGMatrix)

Overloaded. Returns the "true" BoundsRect where the boundaries of the element are modified by the input matrix plus (for graphic elements) its transformation   Matrix

GetFormatStr

Returns a format string for formatting floating point numbers

GetNearestViewBox

Returns the nearest ancestor (Parent, or Parent of Parent, or etc) element that is a TSVGCustomViewBox element

GetOptions

Represents method GetOptions.

GetOwner

Returns the SVG document that owns this element

GetSVGType

Returns the SVG element type of the class

GetUnitFactors

Returns unit factors array, which specifies the unit factors for conversion of different units into pixel units. For example, if the input string contains '1cm', the function uses the UnitFactors variable of this type to know how large a centimeter is.

GetViewMatrix(TRect)

Overloaded. Returns a transformation matrix for viewing this element

GetViewMatrix(TSVGMatrix,TRect)

Overloaded. Returns a transformation matrix for viewing this element

GetViewMatrix(TSVGMatrix,TSVGRect)

Overloaded. Returns a transformation matrix for viewing this element

GetViewMatrix(TSVGRect)

Overloaded. Returns a transformation matrix for viewing this element

HasAncestor(TSVGElement)

Returns true if the input element is an ancestor of the current SVG element

HasChild(TSVGElement)

Returns true if the input element is a direct child of the current SVG element

HasDescendant(TSVGElement)

Returns true if the input element is a descendant of the current SVG element

HasExtensions

Returns true if the required extensions are present. The RSCL supports no extensions at this time, if RequiredExtensions is not empty, this method will return False

HasFeatures

Returns true if the Owner document supports all of the features of the element. If all of the given features are supported, then the function evaluates to true; otherwise, the current element and its children are skipped and thus will not be rendered.

HasFollowing(TSVGElement)

Returns true if the input element follows the current SVG element

HasLanguage(String)

Returns True if the Language property matches the language IDs in the input parameter. Multiple languages can be specified by separating the language IDs with commas and/or spaces.

HasLanguages

Returns True if the Owner SVG document fragment supports the Language property or one of the SystemLanguages

HasPreceding(TSVGElement)

Returns true if the input element precedes the current SVG element

HasSibling(TSVGElement)

Returns true if the input element is a sibling (share same Parent) of the current SVG element

IsCompactXML

Returns true if the svg XML should be made as small as possible when exporting the svg element as XML

IsEnabled

Returns true if the current element and every parent, grandparent, etc are FMX.RS.SVG.TSVGElement.Enabled.

LoadFromXML(IXMLNode)

Loads the SVG element's attributes and child nodes from the XML node

Matches(String)

Returns the specificity (>=0) of the match with the selector string or -1 if there is no match.

A selector's specificity is calculated as follows:

• Count the number of ID selectors in the selector (= a)

• Count the number of class selectors, attributes selectors, and pseudo-classes in the selector (= b)

• Count the number of type selectors and pseudo-elements in the selector (= c)

• Ignore the universal selector

• Selectors inside the negation pseudo-class are counted like any other, but the negation itself does not count as a pseudo-class.

ControlConstructor

Represents field ControlConstructor.

FAttributes

Represents field FAttributes.

FElementState

Represents field FElementState.