<< Click here to display Table of Contents >> Navigation: Code Documentation > RSVclImpact > RS.Impact.Clocks > Classes:

TRSClock Class

Contents

Comments (0)

Provides a circular, analog clock with three hands. Use the RS.Impact.Clocks.TRSClock.Time property to set the time of the clock. Use the RS.Impact.Clocks.TRSClock.Parts property to specify which parts (frame, backface, glass, hands, etc) to render.

RSClock

Namespace: RS.Impact.Clocks

	Name	Description
	BACKFACECIRCLE_ID	Represents constant BACKFACECIRCLE_ID.
	BACKFACE_ID	Represents constant BACKFACE_ID.
	BOTTOM_SHINE_ID	Represents constant BOTTOM_SHINE_ID.
	CLOCKHANDS_ID	Represents constant CLOCKHANDS_ID.
	DECORATION_ID	Represents constant DECORATION_ID.
	DefaultFormatStr	Represents constant DefaultFormatStr. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	FRAMEINNERBEVEL_ID	Represents constant FRAMEINNERBEVEL_ID.
	FRAMEOUTERBEVEL_ID	Represents constant FRAMEOUTERBEVEL_ID.
	FRAMESHADOW_ID	Represents constant FRAMESHADOW_ID.
	FRAMETONE10TO3_ID	Represents constant FRAMETONE10TO3_ID.
	FRAMETONE4TO9_ID	Represents constant FRAMETONE4TO9_ID.
	FRAMETOP_ID	Represents constant FRAMETOP_ID.
	FRAMETWOTONE_ID	Represents constant FRAMETWOTONE_ID.
	FRAME_ID	Represents constant FRAME_ID.
	GLASS_ID	Represents constant GLASS_ID.
	GRADIENTBACKFACE_ID	Represents constant GRADIENTBACKFACE_ID.
	GRADIENTBEVEL_ID	Represents constant GRADIENTBEVEL_ID.
	GRADIENTDARKLABELS_ID	Represents constant GRADIENTDARKLABELS_ID.
	GRADIENTFRAME10TO3_ID	Represents constant GRADIENTFRAME10TO3_ID.
	GRADIENTFRAME4TO9_ID	Represents constant GRADIENTFRAME4TO9_ID.
	GRADIENTFRAMESHADOW_ID	Represents constant GRADIENTFRAMESHADOW_ID.
	GRADIENTGLASSBOTTOM_ID	Represents constant GRADIENTGLASSBOTTOM_ID.
	GRADIENTGLASSTOP_ID	Represents constant GRADIENTGLASSTOP_ID.
	GRADIENTHOURHAND_ID	Represents constant GRADIENTHOURHAND_ID.
	GRADIENTKNOB_ID	Represents constant GRADIENTKNOB_ID.
	GRADIENTLIGHTLABELS_ID	Represents constant GRADIENTLIGHTLABELS_ID.
	GRADIENTMINUTEHAND_ID	Represents constant GRADIENTMINUTEHAND_ID.
	GRADIENTSECONDHAND_ID	Represents constant GRADIENTSECONDHAND_ID.
	HOURHANDNEEDLE_ID	Represents constant HOURHANDNEEDLE_ID.
	HOURHANDSHADOW_ID	Represents constant HOURHANDSHADOW_ID.
	HOURHAND_ID	Represents constant HOURHAND_ID.
	KNOB_ID	Represents constant KNOB_ID.
	LABELS10TO3_ID	Represents constant LABELS10TO3_ID.
	LABELS4TO9_ID	Represents constant LABELS4TO9_ID.
	LABELS_ID	Represents constant LABELS_ID.
	MINUTEHANDNEEDLE_ID	Represents constant MINUTEHANDNEEDLE_ID.
	MINUTEHANDSHADOW_ID	Represents constant MINUTEHANDSHADOW_ID.
	MINUTEHAND_ID	Represents constant MINUTEHAND_ID.
	SECONDHANDNEEDLE_ID	Represents constant SECONDHANDNEEDLE_ID.
	SECONDHANDSHADOW_ID	Represents constant SECONDHANDSHADOW_ID.
	SECONDHAND_ID	Represents constant SECONDHAND_ID.
	SVG_RESOURCE_NAME	Represents constant SVG_RESOURCE_NAME.
	TOPRIGHT_SHINE_ID	Represents constant TOPRIGHT_SHINE_ID.

Top

Name

Description

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.

Note
It is recommended that the active portion of the SVG not be too drawing intensive as it will slow painting.

Align

Represents property Align.

Anchors

Represents property Anchors.

AutoSize

Represents property AutoSize.

BackfaceColor

Specifies the color of the inner face of the clock. Use this property to change the color of the backface

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.

Note
It is not recommended to change SVG elements in the background too often as it requires a complete rerendering of the background.

Buffered

Represents property Buffered.

Constraints

Represents property Constraints.

Decoration

Represents property Decoration.

DecorationFillColor

Represents property DecorationFillColor.

DecorationID

Specifies the ID of the element in the SVG that contains the Decoration for the instrument. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)

DecorationPath

Represents property DecorationPath.

DecorationStrokeColor

Represents property DecorationStrokeColor.

Design

Represents property Design.

DragCursor

Represents property DragCursor.

DragKind

Represents property DragKind.

DragMode

Represents property DragMode.

Enabled

Represents property Enabled.

EnableGradients

Represents property EnableGradients.

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.

Note
It is not recommended to change SVG elements in the background too often as it requires a complete rerendering of the background.

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) (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)

FrameColor

Specifies the color of the outer frame of the clock. Use this property to change the color of the frame

Height

Represents property Height.

HourHandFillColor

Specifies the fill color of hour hand of the clock. Use this property to change the color of the hour hand

HourHandStrokeColor

Specifies the stroke color of hour hand of the clock. Use this property to change the stroke color of the hour hand

KnobFillColor

Specifies the fill color of the knob or cover in the exact middle of the clock that covers the pivot points for the clock hands. Use this property to change the fill color of the knob

KnobStrokeColor

Specifies the stroke color of the knob or cover in the exact middle of the clock that covers the pivot points for the clock hands. Use this property to change the stroke color of the knob

LabelsFillColor

Specifies the fill color of the outer digits or labels on the clock. Use this property to change the fill color of the labels.

LabelsStrokeColor

Specifies the stroke color of the outer digits or labels on the clock. Use this property to change the stroke color of the labels.

LightColor

Represents property LightColor.

Matrix

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

MinuteHandFillColor

Specifies the fill color of minute hand of the clock. Use this property to change the color of the minute hand

MinuteHandStrokeColor

Specifies the stroke color of minute hand of the clock. Use this property to change the stroke color of the minute hand

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

Represents property OnChange.

OnClick

Represents property OnClick.

OnContextPopup

Represents property OnContextPopup.

OnDblClick

Represents property OnDblClick.

OnDragDrop

Represents property OnDragDrop.

OnDragOver

Represents property OnDragOver.

OnDrawing

Represents property OnDrawing.

OnDrawn

Represents property OnDrawn.

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.

Parts

Specifies the visible parts of the gauge. Use the Parts property to configure which parts of the instrument that IMPACT should draw.

PopupMenu

Represents property PopupMenu.

Quality

Represents property Quality.

SecondHandFillColor

Specifies the fill color of second hand of the clock. Use this property to change the color of the second hand

SecondHandStrokeColor

Specifies the stroke color of second hand of the clock. Use this property to change the stroke color of the second hand

ShadowColor

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

ShowHint

Represents property ShowHint.

Stretch

Represents property Stretch.

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.)

Time

Specifies the current time and/or date of the clock

Touch

Represents property Touch.

Transform

Represents property Transform.

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. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)

Visible

Represents property Visible.

Width

Represents property Width.

Top

	Name	Description
	AfterConstruction	Represents method AfterConstruction. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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 (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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. (Overrides RS.Impact.Instruments.TRSSVGCustomInstrument.GetSVGResourceName.)
	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 (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	LoadSVGProperties	Initializes local properties from the SVG. Descendant classes override this method to initialize their properties (such as FrameColor) from elements in the SVG. (Overrides RS.Impact.Instruments.TRSSVGCustomInstrument.LoadSVGProperties.)
	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. (Overrides RSSVGControl.TRSSVGControl.LoadSVGResource(String).)
	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. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	SaveGradientColor(TSVGCustomGradient)	Stores gradient stop colors in the tags of the SVG elements. This allows restoring the gradient stop colors without reloading the svg (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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. (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	UpdateDecorationFill	Updates the Decoration fill color in the gauge (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	UpdateDecorationStroke	Updates the Decoration stroke color in the gauge (Inherited from RS.Impact.Instruments.TRSSVGCustomInstrument.)
	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.
	UpdateTime	Sets the clock hands based on the RS.Impact.Clocks.TRSClock.Time property

Top

Comments (0)

TRSClock Class

Reference