<< Click here to display Table of Contents >> Navigation: Code Documentation > RSVclSVG > RSSVGCtrls > Classes:

TRSSVGThreadImage Class

Contents

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: RSSVGCtrls

TRSCustomTransparentGraphicControl
RSSVGCtrls.TRSSVGThreadImage

Delphi

type
TRSSVGThreadImage = class(TRSCustomTransparentGraphicControl, IRSGPControl)
end;

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

Top

	Name	Description
	AbsoluteMatrix	Represents property AbsoluteMatrix.
	Align	Represents property Align.
	Anchors	Represents property Anchors.
	AutoSize	Represents property AutoSize.
	Bitmap	Represents property Bitmap.
	Constraints	Represents property Constraints.
	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.
	DefaultColorInterpolation	Default Color interpolation type, which specifies the color space for gradient interpolations and alpha compositing VCL Only
	DefaultColorRendering	Default Color rendering type, which provides a hint to the SVG library about how to optimize its color interpolation and compositing operations. VCL Only
	DefaultShapeRendering	Default Shape rendering type, which provides a hint to the SVG library about what tradeoffs to make as it renders vector graphics elements such as path elements and basic shapes such as circles and rectangles. VCL Only
	DefaultTextRendering	Default Text rendering type, which provides a hint to the SVG library about what tradeoffs to make as it renders text VCL Only
	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.
	DragCursor	Represents property DragCursor.
	DragKind	Represents property DragKind.
	DragMode	Represents property DragMode.
	Enabled	Represents property Enabled.
	Filename	Defines the filename of the SVG document to load
	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.
	Matrix	Represents property Matrix.
	OnClick	Represents property OnClick.
	OnContextPopup	Represents property OnContextPopup.
	OnDblClick	Represents property OnDblClick.
	OnDragDrop	Represents property OnDragDrop.
	OnDragOver	Represents property OnDragOver.
	OnEndDock	Represents property OnEndDock.
	OnEndDrag	Represents property OnEndDrag.
	OnGesture	Represents property OnGesture.
	OnMouseActivate	Represents property OnMouseActivate.
	OnMouseDown	Represents property OnMouseDown.
	OnMouseEnter	Represents property OnMouseEnter.
	OnMouseLeave	Represents property OnMouseLeave.
	OnMouseMove	Represents property OnMouseMove.
	OnMouseUp	Represents property OnMouseUp.
	OnStartDock	Represents property OnStartDock.
	OnStartDrag	Represents property OnStartDrag.
	Opacity	Specifies the opacity or transparency of the SVG image. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.
	Options	Controls how the SVG is loaded and displayed
	ParentShowHint	Represents property ParentShowHint.
	PopupMenu	Represents property PopupMenu.
	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
	ShowHint	Represents property ShowHint.
	SVG	Represents property SVG.
	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.
	Touch	Represents property Touch.
	Transform	Specifies the overall transformation to apply to the SVG image. For no transformation, set the Matrix to the RSIdentityMatrix
	Visible	Represents property Visible.
	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.
	GetAbsoluteMatrix	Represents method GetAbsoluteMatrix.
	GetMatrix	Represents method GetMatrix.
	GetOpacity	Represents method GetOpacity.
	GetShapeRect(TObject,TRSRect)	Represents method GetShapeRect(TObject,TRSRect).
	JobComplete(TObject)	Represents method JobComplete(TObject).
	LoadSVG	Represents method LoadSVG.
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Paint	Represents method Paint.
	Resize	Represents method Resize.
	SetOpacity(Single)	Represents method SetOpacity(Single).
	UpdateBitmap	Represents method UpdateBitmap.

Top

Tip
The TRSSVGThreadImage always loads (Windows-only) 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

•	RSSVGCtrls.TRSSVGImage

•	RSSVGCtrls

Comments (0)