VectorIcon

AbstractIconReferences
[IoId("00000000-ba64-4792-9acf-45bd1328dfc9")] public class VectorIcon : AbstractIcon, IStorable
Implements IIcon for vector graphics.

Constructors

VectorIcon

#
public VectorIcon(Builder builder)
Create a new vector icon.
Parameters:
builder (Builder)Builder with all vector shapes and states.

VectorIcon

#
public VectorIcon(IReader reader)
Deserialisation constructor.
Parameters:
reader (IReader)

Fields

NullRank

#
public const int NullRank = -2147483648
Defines the null category, ie. the category that cannot be hidden.

Properties

Size

#
public Size Size { get; }
Gets the frame within which this icon is positioned.

States

public IEnumerable<IconState> States { get; }
Enumerate over all state names.
inherited fromAbstractIcon
Implements: States

Type

public IconType Type { get; }
Gets the type of icon.
inherited fromAbstractIcon
Implements: Type

Methods

AddState

protected void AddState(IconState state)
Add a state to this icon. This method ought to be called from the constructor of derived types only.
inherited fromAbstractIcon
Parameters:
state (IconState)State to add.

Draw

public void Draw(IconContext context)
Render this icon into a graphics context.
inherited fromAbstractIcon
Parameters:
context (IconContext)Graphics context for icon.
Implements: Draw

DrawDropShadow

public Bitmap DrawDropShadow(Size size, int blur, float strength)
Create a bitmap containing the drop shadow of this icon.
inherited fromAbstractIcon
Parameters:
size (Size)Size of the icon in pixels.
blur (int)Amount of blurring.
strength (float)Darkness of shadow.
Returns: A bitmap with only black pixels and varying transparencies. The size of this bitmap is the provided size plus padding to cater for the blurring.

DrawInternal

#
protected override void DrawInternal(IconContext context)
Internal render method.
Parameters:
context (IconContext)Graphics context.
Overrides: AbstractIcon.DrawInternal

DrawToBitmap

public Bitmap DrawToBitmap(Size size, int padding, Color background)
Render the icon to a bitmap.
inherited fromAbstractIcon
Parameters:
size (Size)Size of bitmap.
padding (int)Number of padding pixels around entire image.
background (Color)Icon background colour. Note that the actual bitmap will be drawn on a Transparent background. This argument merely informs those parts of icon that case about background/foreground contrast.
Returns: Rendered bitmap.
Implements: DrawToBitmap

FindState

public IconState FindState(string name)
Find the icon state with the specified name.
inherited fromAbstractIcon
Parameters:
name (string)Name to search for.
Returns: Icon state with given name or null.
Implements: FindState

HandleStateChange

#
protected override void HandleStateChange(IconState state)
Parameters:
state (IconState)
Overrides: AbstractIcon.HandleStateChange

Hide

#
public void Hide(int rank)
Hide a specific category.
Parameters:
rank (int)Category to show.

MoveState

public void MoveState(double value, string name = null, Duration? duration = null, Motion? motion = null)
Move a named state to a new value over time.
inherited fromAbstractIcon
Parameters:
value (double)State value to assign.
name (string = null)Name of state. Leave blank to set the default state.
duration (Duration? = null)Animation duration. Leave blank to re-use the previous duration.
motion (Motion? = null)Animation motion. Leave blank to re-use the previous motion.
Implements: MoveState

SetState

public void SetState(double value, string name = null)
Set the value of a named state immediately.
inherited fromAbstractIcon
Parameters:
value (double)State value to assign.
name (string = null)Name of state. Leave blank to set the default state.
Implements: SetState

Show

#
public void Show(int rank)
Show (ie. unhide) a specific category.
Parameters:
rank (int)Category to show.

ShowAll

#
public void ShowAll()
Show all categories.

ShowOnly

#
public void ShowOnly(int rank)
Show a single category, hide all others.
Parameters:
rank (int)Category to show.

Store

#
public void Store(IWriter writer)
Serialise this icon.
Parameters:
writer (IWriter)
Implements: Store

ToSvgXml

#
public string ToSvgXml()
Create an xml document from this icon.