Radial Brush (PRIM_VS.RadialBrush)

Gradient colors in a circular or elliptical pattern

Ancestors - Gradient Brush (PRIM_VS.GradientBrush)Brush (PRIM_VS.Brush)Object (PRIM_OBJT)

Details

A Radial Brush is used to create a gradient color that transitions between the colors specified in the Colors property.
 
Radial Brush has Origin, Center, and Radius coordinates. The brush radiates from the Center along the extent of the Radius similar to a Linear Brush but instead producing a circular pattern.
 
By having the Origin and Center coordinates the same, the brush will always appear as though directly in front of the view. However, changing the value changes the shape and the brush appears skewed.  A simple analogy is that of looking at the beam of a torch.  A RadialBrush can be thought of as a 2D view of a 3D shape.  The Origin is the position of the torch, Center is the middle of the light as it shines on something, and Radius describes the width.
 
If there is sufficient difference between the origin and center, it is no longer possible to see the base, just a "triangular" side view of the beam of light.

Example

The example below is a simple radial brush that changes from red at 0, to blue producing a red center and blue outer.

Begin_Com Role(*EXTENDS #PRIM_WEB) Height(457) Width(1169) Style(#Style1)
 
   Define_Com Class(#PRIM_VS.Style) Name(#Style1) Backgroundbrush(#RadialBrush)
   Define_Com Class(#Prim_Vs.RadialBrush) Name(#RadialBrush) Colors(#RadialBrushColors)
   Define_Com Class(#Prim_Vs.BrushColors) Name(#RadialBrushColors)
   Define_Com Class(#Prim_Vs.BrushColor) Name(#RadialBrushColor1) Color(Red) Parent(#RadialBrushColors)
   Define_Com Class(#Prim_Vs.BrushColor) Name(#RadialBrushColor2) At(100) Color(Blue) Parent(#RadialBrushColors)
 
End_Com

Properties

Name	Description
CenterLeft	One of six coordinates used to define the axis and extent of the brush
CenterTop	One of six coordinates used to define the axis and extent of the brush
Colors	Collection of colors to define the gradient Inherited from Gradient Brush (PRIM_VS.GradientBrush)
ComponentClassName	ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers	ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName	ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag	Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType	ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName	ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Name	Name identifies the component Inherited from Object (PRIM_OBJT)
Opacity	Opacity to be applied to the brush Inherited from Gradient Brush (PRIM_VS.GradientBrush)
OriginLeft	One of six coordinates used to define the axis and extent of the brush
OriginTop	One of six coordinates used to define the axis and extent of the brush
Owner	Owner owns this component Inherited from Object (PRIM_OBJT)
Parent	The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
RadiusLeft	One of six coordinates used to define the axis and extent of the brush
RadiusTop	One of six coordinates used to define the axis and extent of the brush
Spread	Defines brush behavior outside the bounds of the specified color range Inherited from Gradient Brush (PRIM_VS.GradientBrush)

Events

Name	Description
CreateInstance	CreateInstance is signalled when an instance of a component is created Inherited from Gradient Brush (PRIM_VS.GradientBrush)
DestroyInstance	DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Gradient Brush (PRIM_VS.GradientBrush)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020