TRSSVGCustomInstrument Class

DefaultFormatStr

Represents constant DefaultFormatStr.

Create(TComponent)

Initializes a new instance of the TRSSVGCustomInstrument class. (Overrides RSSVGControl.TRSSVGControl.Create(TComponent).)

AbsoluteMatrix

Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices. (Inherited from RSSVGControl.TRSSVGControl.)

ActiveSVGElement

Specifies the dynamic element in the SVG, the part that will be changing often. The ActiveSVGElement is not buffered when painting as it is assumed it will be changing. Set the ActiveSVGElement to tell the control which element or group of elements need to be redrawn every paint event.

The non-active svg elements are rendered either to the     Background or     Foreground Buffer.

Align

Represents property Align.

Anchors

Represents property Anchors.

AutoSize

Represents property AutoSize.

Background

Contains the static background of the SVG compared to the   ActiveSVGElement, i.e. the SVG elements that are rendered behind the ActiveSVGElement. The Background and Foreground are painted once from the SVG. When elements in the ActiveSVGElement group change, the Background and Foreground are not rendered again, significantly speeding up painting of the entire SVG.

Buffered

Specifies whether to draw the SVG to a backbuffer and then copy that image to the canvas (default) or to draw directly on the canvas

Set the Buffered property to false to draw directly on the image canvas. This is generally not recommended, however, it may look better on mobile devices

Constraints

Represents property Constraints.

Decoration

Defines the shape to use as a decoration for the instrument. The decoration can be pre-defined paths or a custom path. Use   DecorationFillColor and   DecorationStrokeColor to customize the colors of the decoration.

DecorationFillColor

Specifies the fill color for the decoration

DecorationID

Specifies the ID of the element in the SVG that contains the   Decoration for the instrument.

DecorationPath

Provides access to the path data for the decoration. If the Decoration element does not exist in the SVG, this property does nothing and returns nil.

DecorationStrokeColor

Specifies the stroke or pen color of the decoration

Design

Use the Design property to quickly switch between detailed and simpler versions of the instrument. The simple option removes extra detail (such as bevels, glass look, shadows, bolts or screws, etc) in the gauge to provide a more basic and faster to draw version of the gauge.

The Design and EnableGradients properties are holistic-type properties which rapidly change the entire look of the instrument.

DragCursor

Represents property DragCursor.

DragKind

Represents property DragKind.

DragMode

Represents property DragMode.

Enabled

Represents property Enabled.

EnableGradients

Use the EnableGradients property to remove gradients from the gauge and use solid colors instead. This option improves speed when drawing the component, and gives gauges a generally flatter look.

The Design and EnableGradients properties are holistic-type properties which rapidly change the entire look of the instrument.

Foreground

Contains the static foreground of the SVG compared to the   ActiveSVGElement, i.e. the SVG elements that are rendered in front of the ActiveSVGElement. The Background and Foreground are painted once from the SVG. When elements in the ActiveSVGElement group change, the Background and Foreground are not rendered again, significantly speeding up painting of the entire SVG.

FormatStr

Defines the format of floating point numbers that are displayed in text elements within the gauge. Change this property to change how numbers are displayed (e.g., significant digits)

Height

Represents property Height.

LightColor

Specifies the color of the light for the instrument. Change the light color to give the instrument a slight color cast.

Matrix

Returns the transformation matrix of the control (Inherited from RSSVGControl.TRSSVGControl.)

NeedBuffers

Controls whether the Background and Foreground need to be rendered again in the Buffered paint process. Set the NeedBuffers property to True to force the buffers to be redrawn at the next paint event. (Inherited from RSSVGControl.TRSSVGControl.)

OnChange

Occurs when the instrument has been modified. Use the OnChange event to respond to changes. Note that BeginUpdate/EndUpdate can delay change events until the last matching EndUpdate method is called.

OnClick

Represents property OnClick.

OnContextPopup

Represents property OnContextPopup.

OnDblClick

Represents property OnDblClick.

OnDragDrop

Represents property OnDragDrop.

OnDragOver

Represents property OnDragOver.

OnDrawing

Occurs just before drawing the current element and its children. The event fires after the canvas brush, pen, font, clipping, etc are set up but before the actual drawing. (Inherited from RSSVGControl.TRSSVGControl.)

OnDrawn

Occurs just after a SVG element is drawn. The event fires after drawing the current element and its children but before the canvas is returned to its initial state. (Inherited from RSSVGControl.TRSSVGControl.)

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.

OnPaint

Represents property OnPaint.

OnPainting

Represents property OnPainting.

OnStartDock

Represents property OnStartDock.

OnStartDrag

Represents property OnStartDrag.

Opacity

Represents property Opacity.

ParentShowHint

Represents property ParentShowHint.

PopupMenu

Represents property PopupMenu.

Quality

Controls the quality of the RSSVGControl.TRSSVGControl.Buffered painting of the SVG image. The value of quality can vary between 1 (low quality) to 8 (very high quality).

ShadowColor

Returns the color to use for shadows in the instrument. This color is calculated from the RS.Impact.Instruments.TRSSVGCustomInstrument.LightColor property.

ShowHint

Represents property ShowHint.

Stretch

Defines if the control draws the SVG stretched to the complete bounds of the control (True) or draws the SVG to the maximum dimensions while respecting the aspect ratio of the SVG (False). (Inherited from RSSVGControl.TRSSVGControl.)

SVG

Contains the SVG that paints the appearance of the control. The control changes the SVG elements based on requirements of the control. For example, a descendant control could change a specific element's fill and stroke based on a Color property change. (Inherited from RSSVGControl.TRSSVGControl.)

Touch

Represents property Touch.

Transform

Specifies the overall transformation to apply to the instrument image. For no transformation, set the Matrix to the RSIdentityMatrix (Inherited from RSSVGControl.TRSSVGControl.)

UpdateCount

Tracks the number of BeginUpdate calls with unmatching EndUpdate calls, i.e., if UpdateCount is greater than 0, the code is between BeginUpdate and EndUpdate and should not signal a change event.

Visible

Represents property Visible.

Width

Represents property Width.

AfterConstruction

Represents method AfterConstruction.

BeginUpdate

Prevents the updating of the instrument until the   EndUpdate method is called.
 
BeginUpdate prevents the screen from being repainted and OnChange events being triggered when instrument properties are changed. Use BeginUpdate to prevent screen repaints and to speed processing time while modifying the instrument.
 
Note: Calls to BeginUpdate are cumulative; for every call to BeginUpdate there must be a corresponding call to EndUpdate.

ChangeGradientColor(TSVGCustomGradient,TSVGColor,Boolean)

Overloaded.  Attempts to modify a gradient color scheme to a similar color scheme using NewColor, i.e., if a gradient has 3 gradient stops of dark gray, gray, white and the NewColor is Red, the method will try to change the gradient to red, lighter red, and white.

The FromFirst parameter specifies if the first or the last gradient stop is the base color to replace. The base color is replaced with the NewColor unchanged. All other gradient stops are modified from the base color.

ChangeGradientColor(TSVGCustomGradient,TSVGColor,Integer)

Overloaded.  Attempts to modify a gradient color scheme to a similar color scheme using NewColor, i.e., if a gradient has 3 gradient stops of dark gray, gray, white and the NewColor is Red, the method will try to change the gradient to red, lighter red, and white.

The BaseColorIndex parameter specifies if which gradient stop is the base color to replace. The base color is replaced with the NewColor unchanged. All other gradient stops are modified from the base color.

DoEnableGradient(String,String,Boolean,TSVGColor,Boolean)

Helper method for changing a SVG element's color between a gradient or a solid color.

The IsEnabled parameter specifies whether to set the element to the gradient or the solid color.

The IsBrush parameter specifies whether to change the element's brush or pen properties.

DoEnableGradients(Boolean)

This method enables or disables gradients in the SVG for the instrument.

Descendant classes override this method to respond to     EnableGradients property changes.

DoInitializeGauge

Initializes the SVG gauge or instrument from the class properties, i.e., apply the properties to the SVG.

Descendant classes override this method to initialize the SVG that draws the gauge with their properties.

DoOnChange

Triggers the   OnChange event

DoPaint

Represents method DoPaint. (Inherited from RSSVGControl.TRSSVGControl.)

DoUpdateDesign

Updates the SVG design of the instrument to simple or detailed based on Design property.

Descendant classes override this method to modify the SVG in response to     Design property changes. Simple designs usually mean making some extra element's invisible.

DoUpdateLight

Updates colors of SVG elements based on changes in the LightColor property.

Descendant classes can override this method to provide a color cast to the SVG based on     LightColor changes.

DoUpdateParts

Update the parts of the SVG based on changes to the Parts property.

Descendant classes override this method to show or hide different elements in the SVG based on Parts property changes.

EnabledChanged

This method is called when the Enabled property changes. The SVG colors are rendered in grayscale when the control is disabled. (Inherited from RSSVGControl.TRSSVGControl.)

EndUpdate

Re-enables screen repainting and change events that were turned off with the   BeginUpdate method.
 
Use the EndUpdate method to enable screen updating after BeginUpdate has been called. Calls to BeginUpdate are cumulative, so calling EndUpdate will only update the instrument if every other call to BeginUpdate has already been matched by a call to EndUpdate.
 
 

GetAbsoluteMatrix

Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices. (Inherited from RSSVGControl.TRSSVGControl.)

GetDrawRect

Returns the rectangle where the SVG should be drawn. This is dependent on the current stretch value, the control's width and height, and the SVG's width and height. (Inherited from RSSVGControl.TRSSVGControl.)

GetMatrix

Returns the transformation matrix of the control (Inherited from RSSVGControl.TRSSVGControl.)

GetOpacity

Returns the Opacity of the control (Inherited from RSSVGControl.TRSSVGControl.)

GetShapeRect(TObject,TRSRect)

Returns the rectangle for the control (Inherited from RSSVGControl.TRSSVGControl.)

GetSVGResourceName

Returns the name of the resource that contains the SVG. The class uses this name to load the embedded SVG from a resource.

InitializeGauge

Initializes the SVG gauge or instrument from the class properties, i.e., apply the properties to the SVG.

This method calls the     DoInitializeGauge method to actually initialize the SVG based on the class properties. It is recommended that descendant classes override that method to respond to initialization requests.

This method ensures that the buffers get updated and the control is repainted.

IsBuffered

Returns True if the instrument should be drawn to a offscreen bitmap (Inherited from RSSVGControl.TRSSVGControl.)

IsUpdating

Returns true if the instrument is being updated

LoadSVGProperties

Initializes local properties from the SVG. Descendant classes override this method to initialize their properties (such as FrameColor) from elements in the SVG.

LoadSVGResource(String)

Load the SVG from an embedded resource. This method initializes the   ActiveSVGElement property and should be used to initialize any control fields (such as colors) that are dependant on the values in the SVG. (Inherited from RSSVGControl.TRSSVGControl.)

ObjectChanged(TObject)

This method is called when an object property (such as Font) has changed and the control needs to respond to the change. (Inherited from RSSVGControl.TRSSVGControl.)

Resize

Represents method Resize. (Inherited from RSSVGControl.TRSSVGControl.)

RestoreGradientColor(TSVGCustomGradient)

Restores the gradient stop colors from the tags of the SVG elements, previously saved using   SaveGradientColor.

SaveGradientColor(TSVGCustomGradient)

Stores gradient stop colors in the tags of the SVG elements. This allows restoring the gradient stop colors without reloading the svg

SetOpacity(Single)

Sets the opacity of the control. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.
 (Inherited from RSSVGControl.TRSSVGControl.)

UpdateBuffers

Updates the   Foreground and   Background buffers with the non active elements of the SVG. (Inherited from RSSVGControl.TRSSVGControl.)

UpdateDecoration

Updates the shape of the decoration (   DecorationPath) based on changes to the   Decoration property.

UpdateDecorationFill

Updates the   Decoration fill color in the gauge

UpdateDecorationStroke

Updates the   Decoration stroke color in the gauge

UpdateDesign

Updates the design of the gauge based on the     Design property. Simpler designs hide elements in the SVG while detailed designs show all elements of the SVG.

This method calls the     DoUpdateDesign method to actually change the SVG based on the Design property. It is recommended that descendant classes override DoUpdateDesign method to respond to design changes.

This method ensures that the buffers get updated and the control is repainted.

UpdateGradients

This method enables or disables gradients in the SVG for the instrument based on     EnableGradients property changes.

This method calls the     DoEnableGradients method to actually enable/disable gradients in the SVG. It is recommended that descendant classes override that method to enable/disable the gradients.

This method ensures that the buffers get updated and the control is repainted.

UpdateLight

Updates colors of SVG elements based on changes in the LightColor property.

Descendant classes can override this method to provide a color cast to the SVG based on     LightColor changes.

This method calls the     DoUpdateLight method to actually perform any color changes in the SVG. It is recommended that descendant classes override that method to do the actual changes.

This method ensures that the buffers get updated and the control is repainted.

UpdateNumbers

This method updates any text elements that display numbers in the gauge. This method is called when the     FormatStr property changes so that the class can respond to new formatting for numbers.

Descendant classes should override this method to update any text elements with numbers

UpdateParts

Update the parts of the SVG based on changes to the Parts property.

Descendant classes override this method to show or hide different elements in the SVG based on Parts property changes.

This method calls the     DoUpdateParts method to actually perform any changes to the SVG. It is recommended that descendant classes override that method to do the actual changes.

This method ensures that the buffers get updated and the control is repainted.