<< Click here to display Table of Contents >> Navigation: Code Documentation > RSFMXSVG > FMX.RS.SVGCtrls > Classes:

TRSSVGThreadImage Class

Contents

Comments (0)

TRSSVGThreadImage displays a graphical image of a SVG. The control ensures that the image is always of the highest resolution by redrawing the SVG when the control is rescaled.

Use TRSSVGThreadImage to display a graphical image of a SVG on a form. Use the Filename or Lines properties to control which SVG is displayed in the image. TRSSVGThreadImage introduces several properties to determine how the SVG is displayed within the boundaries of the TRSSVGThreadImage object.

Namespace: FMX.RS.SVGCtrls

TControl
FMX.RS.SVGCtrls.TRSSVGThreadImage

Delphi

type
TRSSVGThreadImage = class(TControl)
end;

	Name	Description
	Create(TComponent)	Initializes a new instance of the TRSSVGThreadImage class.
	Destroy	Represents the destructor of the TRSSVGThreadImage class.

Top

	Name	Description
	Align	Represents property Align.
	Anchors	Represents property Anchors.
	Bitmap	Represents property Bitmap.
	ClipChildren	Represents property ClipChildren.
	ClipParent	Represents property ClipParent.
	Cursor	Represents property Cursor.
	DefaultAspectRatio	Defines the default aspect ratio for the SVG. If the SVG does not specify a preserveAspectRatio attribute, the SVG will use this default instead.
	DesignVisible	Represents property DesignVisible.
	DisableInterpolation	Enables or disables the interpolation of the SVG bitmap displayed by this TRSSVGThreadImage component. The DisableInterpolation property specifies whether the interpolation is used while rendering the SVG bitmap onto the canvas displayed by this TRSSVGThreadImage component. By default, DisableInterpolation is set to False.
	DPI	Dots per inch used in calculating the unit factors for conversion of string lengths into actual values. The DPI should be set before loading a SVG. For example, if the input string contains '1cm', the DPI helps the SVG library figure out how large a centimeter is.
	DragMode	Represents property DragMode.
	Enabled	Represents property Enabled.
	EnableDragHighlight	Represents property EnableDragHighlight.
	Filename	Defines the filename of the SVG document to load
	Height	Represents property Height.
	HitTest	Represents property HitTest.
	Lines	Defines the text of a SVG to load. The Lines property is useful for when you don't want to load a SVG from a file with the Filename property.
	Locked	Represents property Locked.
	Margins	Represents property Margins.
	MarginWrapMode	Specifies how the margins of the SVG are resized, replicated, and positioned. Use MarginWrapMode property to set and get how the margins of the SVG are displayed within the TRSSVGThreadImage. By default the margins are stretched to fill the entire TRSSVGThreadImage. If SVGMargins property is not set, then MarginWrapMode has no effect over the image.
	OnClick	Represents property OnClick.
	OnDblClick	Represents property OnDblClick.
	OnDragDrop	Represents property OnDragDrop.
	OnDragEnd	Represents property OnDragEnd.
	OnDragEnter	Represents property OnDragEnter.
	OnDragLeave	Represents property OnDragLeave.
	OnDragOver	Represents property OnDragOver.
	OnMouseDown	Represents property OnMouseDown.
	OnMouseEnter	Represents property OnMouseEnter.
	OnMouseLeave	Represents property OnMouseLeave.
	OnMouseMove	Represents property OnMouseMove.
	OnMouseUp	Represents property OnMouseUp.
	OnMouseWheel	Represents property OnMouseWheel.
	OnPaint	Represents property OnPaint.
	OnPainting	Represents property OnPainting.
	OnResize	Represents property OnResize.
	Opacity	Represents property Opacity.
	Options	Controls how the SVG is loaded and displayed
	Padding	Represents property Padding.
	PopupMenu	Represents property PopupMenu.
	Position	Represents property Position.
	RotationAngle	Represents property RotationAngle.
	RotationCenter	Represents property RotationCenter.
	Scale	Represents property Scale.
	ScaleOriginal	Specifies the scale factor for drawing the SVG. Use the ScaleOriginal property to scale the SVG larger or smaller within the TRSSVGThreadImage component. This is useful for controlling the tiling the SVG or zooming in or out of the SVG
	SVG	Represents property SVG.
	SVGMargins	Specifies the margins of the SVG displayed by this TRSSVGThreadImage component. Set or read the SVGMargins property in order to affect the margins of the SVG that is displayed by this TRSSVGThreadImage component
	SVGRootID	Specifies which node of the SVGDocument to draw as the top- level SVG document. Use the SVGRootID property to display only a portion of the SVG Document .
	Thread	Represents property Thread.
	Visible	Represents property Visible.
	Width	Represents property Width.
	WrapMode	Specifies whether and how to resize, replicate, and position the SVG image for rendering the TRSSVGThreadImage surface. The WrapMode property should be one of the constants defined in the TSVGImageWrapMode type: iwOriginal-- displays the SVG with its original dimensions. iwFit-- best fit (keeping SVG proportions--the ratio between the width and height) for the TRSSVGThreadImage rectangle. Default. iwStretch--stretches the SVG to fill the entire rectangle of this TRSSVGThreadImage component. iwTile--tiles the TRSSVGThreadImage image to cover the entire rectangle of the TRSSVGThreadImage component. iwCenter-- center the SVG inside the TRSSVGThreadImage component

Top

	Name	Description
	ClearPendingJobs(TSVGServerJob)	Represents method ClearPendingJobs(TSVGServerJob).
	CreateServerThread	Represents method CreateServerThread.
	DisplayPropertyChange	Represents method DisplayPropertyChange.
	GetBitmap	Represents method GetBitmap.
	JobComplete(TObject)	Represents method JobComplete(TObject).
	LoadSVG	Represents method LoadSVG.
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Paint	Represents method Paint.
	Resize	Represents method Resize.
	UpdateBitmap	Represents method UpdateBitmap.

Top

Important Note
The TRSSVGThreadImage is very dependant on the thread-safety of the implementation of TBitmap/TCanvas. Unlike the VCL, there are known issues with TBitmap thread safety (at least as of XE5), even on Windows (DirectX2D implementation compared to GDI+ implementation). It is not recommended to use TRSSVGThreadImage in FMX - use TRSSVGImage and TRSSVGDocument instead.

Tip
The TRSSVGThreadImage always loads and draws the SVG image in a background thread. As such, it cannot share a TRSSVGDocument and must contain its own SVG. If you want or can share SVG documents amongst multiple image components (and don't mind using the GUI main thread), you may want to use the TRSSVGImage component.

Warning
If the SVGRootID property is not empty, the ID must exist in the SVG document or nothing is displayed.

Important Note
On non-Windows systems, the TRSSVGThreadImage loads the SVG in the main thread and only does the painting in the background thread. This is because the ADOM XML parser, which is used on non-Windows system, crashes when used in background threads.

To load and draw a SVG at run-time, create the SVG document and the SVG Image:

Delphi
SVGImage := TRSSVGThreadImage.Create(Self); SVGImage.Parent := Self; SVGImage.Filename := 'c:\MySVG.svg';

Reference

•	FMX.RS.SVGCtrls.TRSSVGImage

•	FMX.RS.SVGCtrls

Comments (0)