diff --git a/KimonoCore.WinUWP/ReadMe.md b/KimonoCore.WinUWP/ReadMe.md index f997e0c..57cc790 100644 --- a/KimonoCore.WinUWP/ReadMe.md +++ b/KimonoCore.WinUWP/ReadMe.md @@ -1,15016 +1,15016 @@ -#API Documentation - -####Version 01.00.00 - -##Table of Contents - -* [Summary](#Summary) -* [Remarks](#Remarks) -* [Namespaces](#Namespaces) -* [Types](#Types) - - -##Summary - -Kimono Designer allows a developer to graphically edit Skia based graphic objects that can be converted to code and included in any cross-platform language and OS that SkiaSharp supports. KimonoCore.WinUWP is the Windows UWP specific version of the Kimono cross-platform library that provides a helper interface to SkiaSharp. - - -##Remarks - -Kimono Designer and the KimonoCore libraries were created by Microsoft, Inc. and released under the MIT License. - -### License - +# API Documentation + +#### Version 01.00.00 + +## Table of Contents + +* [Summary](#Summary) +* [Remarks](#Remarks) +* [Namespaces](#Namespaces) +* [Types](#Types) + + +## Summary + +Kimono Designer allows a developer to graphically edit Skia based graphic objects that can be converted to code and included in any cross-platform language and OS that SkiaSharp supports. KimonoCore.WinUWP is the Windows UWP specific version of the Kimono cross-platform library that provides a helper interface to SkiaSharp. + + +## Remarks + +Kimono Designer and the KimonoCore libraries were created by Microsoft, Inc. and released under the MIT License. + +### License + **Kimono Designer** Copyright (c) Microsoft Corporation All rights reserved. -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a -copy of this software and associated documentation files (the "Software"), -to deal in the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included -in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR -OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. - - -#Namespaces - - ---- - - -##KimonoCore - -

TypeSummary
KimonoSketch

Holds a collection of KimonoShapes that are used to create a given image using Skia.

-
KimonoTool

Defines the current tool that is active in a KimonoSketch that the user can use to create or modify a KimonoShape.

-
Kimono

Holds a set of shared utilities that are used across the Kimono classes.

-
KimonoPortfolio

A Kimono Portfolio holds a collection of KimonoSketches, KimonoStyles and KimonoColors that define a given Kimono Designer project.

-
KimonoUndoHandler

Handles the undo/redo state for a KimonoDesignSurface.

-
KimonoShape

Defines the based shape that all other Kimono Shape types will inherit from.

-
KimonoShapeArrow

Draws either an outlined or single line arrow with heads on one or both ends.

-
KimonoShapeBezier

A Kimono Bezier is a collection of control and end points that define the quad sections of a bezier shape to be drawn using SkiaSharp.

-
KimonoShapeGroup

A KimonoShapeGroup holds a collection of KimonoShapes that can be acted upon as a group.

-
KimonoShapeGroupType

Defines the type of a KimonoShapeGroup.

-
KimonoShapeLine

Draws a line on the design surface.

-
KimonoShapeOval

Draws an oval into the Design Surface.

-
KimonoShapePolygon

Draws a multi-sided polygon into the Design Surface.

-
KimonoShapeRect

Draws a rectangle into the Design Surface.

-
KimonoShapeRoundRect

Draws a rounded rectangle into the Design Surface.

-
KimonoShapeStar

Draws a multi-sided star shape into the Design Surface.

-
KimonoShapeState

Holds the current state of a KimonoShape while it is being edited by the user.

-
KimonoShapeText

Draws a block of text into the Design Surface within the specifid bounds of this shape.

-
KimonoShapeTriangle

Draws a triangle into the Design Surface.

-
KimonoShapeVector

A vector is a hard edged shape consisting of a set of datapoints that will be drawn into the Desing Surface.

-
KimonoProperty

Defines a property that can be attached to another Kimono object (such as a KimonoColor, KimonoStyle or KimonoShape) and be used as a local variable, global variable or a parameter or be the result of a calculation using the Obi Simple Scripting Language.

-
KimonoPropertyUsage

Defines how a KimonoProperty is used when it is attached to a KimonoShape, KimonoSketch or KimonoPortfolio.

-
KimonoPropertyConnectionPoint

Defines the point that a KimonoProperty value can be connected to another Kimono object such as the Top coordinate of a KimonoShape.

-
KimonoPropertyConnection

Defines a connection between a given Kimono Object and a KimonoProperty.

-
ObiScriptResult

Defines the result of attempting to execute an Obi Script on a KimonoProperty

-
KimonoBezierPoint

Holds the control and end point for a KimonoShapeBezier that define a quad section of the Bezier.

-
KimonoBounds

Defines the outter bounding box for a KimonoShape and contains the routines required to draw the bounds and the control handles as the user edits and moves the shape.

-
KimonoHandle

Defines an edit handle that the user manipulates to edit the bounds of a KimonoShape or the control points of a Bezier object.

-
KimonoHandleConstraint

Constrains the movement of a KimonoHandle when it is being moved by the user.

-
KimonoHandleType

Defines the type of a KimonoHandle that can be used as a general purpose control point to adjust the bounds of a KimonoShape or as a point for a vector or bezier object.

-
KimonoBlur

Defines a blur effect that can be attached to the fill or the frame of a KimonoShape.

-
KimonoShadow

Defines a shadow effect that can be attached to the fill or the frame of a KimonoShape.

-
KimonoGradient

Defines a gradient as a collection of either SKColor or linked KimonoColors that can be applied to a KimonoStyle and used when drawing a KimonoShape.

-
KimonoGradientType

Kimono gradient type.

-
KimonoStyle

Defines as style that can be applied to a KimonoShape to control its appearance.

-
KimonoStyleType

Defines the type of a KimonoStyle that will be used to draw a given KimonoShape in.

-
KimonoPropertyRect

Defines a KimonoProperty that represents a SKRect.

-
KimonoPropertyNumber

Defines a KimonoProperty that represents a float or int value.

-
KimonoPropertyStyle

Defines a KimonoProperty that represents a KimonoStyle value.

-
KimonoPropertyBoolean

Defines a KimonoProperty that represents a bool value.

-
KimonoPropertyText

Defines a KimonoProperty that represents a string value.

-
KimonoPropertyColor

Defines a KimonoProperty that represents a KimonoColor value.

-
KimonoPropertyGradient

Defines a KimonoProperty that represents a KimonoGradient value.

-
CodeOutputOS

Defines the OS that code will be generated for

-
CodeOutputLanguage

Defines the language that code will be output in.

-
CodeOutputLibrary

Code output library.

-
KimonoCodeGenerator

The Kimono Code Generator has routine to assist in the generation of output source code.

-
IKimonoCodeGeneration

Interface for any Kimono Object that support source code generation.

-

- - ---- - - -##KimonoCore.Kimono - -

TypeSummary
PortfolioEventDelegate

Portfolio event delegate.

-
SketchEventDelegate

Sketch event delegate.

-
StyleEventDelegate

Style event delegate.

-
ShapeEventDelegate

Shape event delegate.

-
ToolEventDelegate

Tool event delegate.

-
SkiaPointEventDelegate

Skia point event delegate.

-
GroupEventDelegate

Group event delegate.

-
ColorEventDelegate

Color event delegate.

-
SkiaColorEventDelegate

Skia color event delegate.

-
GradientEventDelegate

Gradient event delegate.

-
HandleEventDelegate

Handle event delegate.

-
PropertyEventDelegate

Property event delegate.

-

- - -#Types - - ---- - - -##KimonoSketch - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Holds a collection of `KimonoShapes` that are used to create a given image using Skia. -

FieldsSummary
ShapeUnderConstruction

-ShapeUnderConstruction

- -

Added In API Version 01.00.00

- -

The shape under construction.

-
PreviousSize

-PreviousSize

- -

Added In API Version 01.00.00

- -

The size of the previous of a sketch for a rezise operation.

-
Size

-Size

- -

Added In API Version 01.00.00

- -

The current size of the sketch

-
_tool

-_tool

- -

Added In API Version 01.00.00

- -

The currently KimonoTool that will be used to edit the sketch.

-
_canvasColor

-_canvasColor

- -

Added In API Version 01.00.00

- -

The color of the canvas.

-
_selectedShape

-_selectedShape

- -

Added In API Version 01.00.00

- -

The selected shape.

-
IgnoreDrag

-IgnoreDrag

- -

Added In API Version 01.00.00

- -

If true, the next drag event will be ignored.

-
PerformingDrag

-PerformingDrag

- -

Added In API Version 01.00.00

- -

If true, the user is performing a drag operation.

-
ToolDownAt

-ToolDownAt

- -

Added In API Version 01.00.00

- -

The last point that a KimonoTool went down on the sketch's Design Surface.

-

- -

PropertiesSummary
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
Portfolio

- -

Portfolio

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the portfolio that this sketch belongs to.

- -

Return Value

- -

The parent KimonoPortfolio.

-
ElementName

- -

ElementName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the element as it will be called in generated source code.

- -

Return Value

- -

The name of the element.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
GenerateCodeToOuputToCanvas

- -

GenerateCodeToOuputToCanvas

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

When converting this Sketch to source code, ouput a method that draws into the given SkiaSharp Canvas.

- -

Return Value

- -

true if generate code to ouput to canvas; otherwise, false.

-
GenerateCodeToOuputSkiaData

- -

GenerateCodeToOuputSkiaData

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

When converting this Sketch to source code, output a method that returns the SkiaSharp Data (SKData[]) representing the Sketch.

- -

Return Value

- -

true if generate code to ouput skia data; otherwise, false.

-
GenerateCodeToOuputBitmapImage

- -

GenerateCodeToOuputBitmapImage

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

When converting this Sketch to source code, output a method that returns the Sketch as a OS specific bitmap image.

- -

Return Value

- -

true if generate code to ouput bitmap image; otherwise, false.

-
GenerateCodeToOuputToSkiaSharpViews

- -

GenerateCodeToOuputToSkiaSharpViews

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

When converting this Sketch to source code, output a method that returns the Sketch as class based on the SkiaSharp.Views extension library.

- -

Return Value

- -

true if generate code to ouput to skia sharp views; otherwise, false.

-
Width

- -

Width

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the width.

- -

Return Value

- -

The width.

-
Height

- -

Height

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the height.

- -

Return Value

- -

The height.

-
CanvasColor

- -

CanvasColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color of the canvas.

- -

Return Value

- -

The color of the canvas.

-
DrawCanvas

- -

DrawCanvas

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoSketch should draw the canvas when it is included in another sketch.

- -

Return Value

- -

true if draw canvas; otherwise, false.

-
Shapes

- -

Shapes

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the shapes.

- -

Return Value

- -

The shapes.

-
Tool

- -

Tool

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the tool.

- -

Return Value

- -

The tool.

-
SelectedShape

- -

SelectedShape

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the selected shape.

- -

Return Value

- -

The selected shape.

-
DeeplySelectedShape

- -

DeeplySelectedShape

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the deepest selected shape in a chain of groups.

- -

Return Value

- -

The deeply selected shape.

-
DeeplySelectedGroup

- -

DeeplySelectedGroup

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the deepest selected group in a chain of groups that is in the edit mode.

- -

Return Value

- -

The deeply selected group.

-
SelectedShapeAtBottom

- -

SelectedShapeAtBottom

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selected shape is at the bottom.

- -

Return Value

- -

true if selected shape at bottom; otherwise, false.

-
SelectedShapeAtTop

- -

SelectedShapeAtTop

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selected shape is at the top.

- -

Return Value

- -

true if selected shape at top; otherwise, false.

-
CanAlignShapes

- -

CanAlignShapes

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether alignment can be applied on a set of shapes.

- -

Return Value

- -

true if can align shapes; otherwise, false.

-
CanGroupShapes

- -

CanGroupShapes

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selection of shapes can be grouped.

- -

Return Value

- -

true if can group shapes; otherwise, false.

-
CanUngroupShapes

- -

CanUngroupShapes

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selection of shapes can be ungrouped.

- -

Return Value

- -

true if can group shapes; otherwise, false.

-

- -

MethodsSummary
KimonoSketch

- -

KimonoSketch ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoSketch class.

-
KimonoSketch

- -

KimonoSketch (System.String, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoSketch class.

- -

ParameterSummary
name

-Name.

-
width

-Width.

-
height

-Height.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
SavePreviousSize

- -

SavePreviousSize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Saves the previous size of the sketch.

-
ApplySizeChange

- -

ApplySizeChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the size change.

-
RemovePropertyConnection

- -

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the property connection.

- -

ParameterSummary
connection

-The KimonoPropertyConnection to remove.

-

-
RemoveProperty

- -

RemoveProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes any connection using this property.

- -

ParameterSummary
property

-The KimonoProperty to remove.

-

-
FindShape

- -

FindShape (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the shape specified by its unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

If found, the KimonoShape will be returned, else null.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draw this sketch into the give SkiaSharp canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
MoveSelectedShapeToBottom

- -

MoveSelectedShapeToBottom ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape to bottom.

-
MoveSelectedShapeBackwards

- -

MoveSelectedShapeBackwards ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape backwards.

-
MoveSelectedShapeToTop

- -

MoveSelectedShapeToTop ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape to top.

-
MoveSelectedShapeForwards

- -

MoveSelectedShapeForwards ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape forwards.

-
AddShape

- -

AddShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the shape.

- -

ParameterSummary
shape

-The KimonoShape to add.

-

-
RecalculateLayerDepths

- -

RecalculateLayerDepths ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Recalculates the layer depths.

- -

Remarks

- -

Layer depths are used to maintain the front to back order of the KimonoShapes that for the sketch.

-
DuplicateSelectedShape

- -

DuplicateSelectedShape ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the selected shape.

-
DeleteSelectedShape

- -

DeleteSelectedShape ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the selected shape.

-
SelectShape

- -

SelectShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Selects the given shape.

- -

ParameterSummary
shape

-The KimonoShape to select.

-

-
DeselectAll

- -

DeselectAll ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deselects all shapes in the sketch.

-
GroupUngroupSelectedShapes

- -

GroupUngroupSelectedShapes ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Groups or ungroups the currently selected group of shapes based on the current selection type.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
BuildCsharpToCanvasMethod

- -

BuildCsharpToCanvasMethod (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Build the method to draw into a specific SkiaSharp Canvas in C# source code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The source code for the method.

-
BuildCsharpToSkiaDataMethod

- -

BuildCsharpToSkiaDataMethod (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Bulids the method to convert this Sketch to SkiaSharp data (SKData).

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The Sketch as SKData.

-
BuildCsharpToBitmapImage

- -

BuildCsharpToBitmapImage (KimonoCore.CodeOutputOS)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Bulids the method to convert this Sketch to OS specific bitmap image format.

- -

ParameterSummary
outputOS

-Output os.

-

- -

Returns

- -

Sketch as a platform specific image.

-
BuildCSharpCrossPlatformToImage

- -

BuildCSharpCrossPlatformToImage (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Builds the C# ToImage method for Cross Platform image support.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

Conditionally compiled code to support all of the different image types.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCSharpUsingStatements

- -

ToCSharpUsingStatements (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Builds the C# using statements.

- -

ParameterSummary
outputOS

-The CodeOutputOS to write code for.

-
outputLibrary

-Output library.

-

- -

Returns

- -

The required using statements based on what other features have been selected.

-
PortfolioSketchMethods

- -

PortfolioSketchMethods (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary, System.String@, System.String@)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the methods that a portfolio will use to draw the sketch.

- -

ParameterSummary
outputOS

-The CodeOutputOS to generate code for.

-
outputLibrary

-The CodeOutputLibrary to use.

-
privateMethodsCode

-The private methods required by this sketch.

-
publicMethodsCode

-The public methods required by this sketch.

-

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCSharpKimono

- -

ToCSharpKimono (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this sketch to C# code using the KimonoCore library.

- -

ParameterSummary
outputOS

-The CodeOutputOS to create code for.

-
outputLanguage

-The CodeOutputLanguage to use.

-
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The sketch as source code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
RelinkShape

- -

RelinkShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the given shape after a clone operation.

- -

ParameterSummary
shape

-The KimonoShape to relink.

-

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

A deep clone of this KimonoSketch.

-
ToolDown

- -

ToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user placing the current KimonoTool down on the sketch's Design Surface.

- -

ParameterSummary
point

-The SKPoint where the tool went down on the Design Surface.

-
clicks

-The number of time the user clicked/tapped the tool down on the Design Surface.

-
multiSelect

-If true, the user has started a multi-shape select process.

-

-
ToolDrag

- -

ToolDrag (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handle the user dragging the selected KimonoTool on the sketch's Design Surface.

- -

ParameterSummary
point

-The SKPoint representing the new tool position on the Design Surface.

-

-
ToolUp

- -

ToolUp (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user lifting the current KimonoTool off of the sketch's Design Surface.

- -

ParameterSummary
point

-The SKPoint where the user lifted up the tool.

-

-
RaiseRequestNewUndoPoint

- -

RaiseRequestNewUndoPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the request new undo point event.

-
RaiseSketchSizeChanged

- -

RaiseSketchSizeChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the sketch size changed event.

-
RaiseSketchModified

- -

RaiseSketchModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the sketch modified event.

-
RaiseImageBufferNeedsRefresh

- -

RaiseImageBufferNeedsRefresh ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the image buffer needs refresh event.

-
RaiseSelectedShapeModified

- -

RaiseSelectedShapeModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the selected shape modified event.

-
RaiseSelectionChanged

- -

RaiseSelectionChanged (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the selection changed event.

- -

ParameterSummary
selected

-Selected.

-

-
RaiseToolChanged

- -

RaiseToolChanged (KimonoCore.KimonoTool)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the tool changed event.

- -

ParameterSummary
tool

-The new KimonoTool that has been selected.

-

-

- -

EventsSummary
RequestNewUndoPoint

- -

RequestNewUndoPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when a new undo point is requested.

-
SketchSizeChanged

- -

SketchSizeChanged

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when sketch size changed.

-
SketchModified

- -

SketchModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when sketch modified.

-
ImageBufferNeedsRefresh

- -

ImageBufferNeedsRefresh

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when image buffer needs refresh.

-
SelectedShapeModified

- -

SelectedShapeModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when selected shape is modified.

-
SelectionChanged

- -

SelectionChanged

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when selection changed.

-
ToolChanged

- -

ToolChanged

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when tool changed.

-

- - ---- - - -##KimonoTool - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the current tool that is active in a `KimonoSketch` that the user can use to create or modify a `KimonoShape`. -

FieldsSummary
Cursor

-Cursor

- -

Added In API Version 01.00.00

- -

Use the Cursor tool to modify an existing KimonoShape.

-
Line

-Line

- -

Added In API Version 01.00.00

- -

Use the Line tool to add a new KimonoShapeLine to the sketch.

-
Arrow

-Arrow

- -

Added In API Version 01.00.00

- -

Use the Arrow tool to add a new KimonoShapeArrow to the sketch.

-
Rectangle

-Rectangle

- -

Added In API Version 01.00.00

- -

Use the Rectangle tool to add a new KimonoShapeRect to the sketch.

-
Oval

-Oval

- -

Added In API Version 01.00.00

- -

Use the Oval tool to add a new KimonoShapeOval to the sketch.

-
RoundRect

-RoundRect

- -

Added In API Version 01.00.00

- -

Use the Round Rect tool to add a new KimonoShapeRoundRect to the sketch.

-
Star

-Star

- -

Added In API Version 01.00.00

- -

Use the Star tool to add a new KimonoShapeStar to the sketch.

-
Polygon

-Polygon

- -

Added In API Version 01.00.00

- -

Use the Polygon tool to add a new KimonoShapePolygon to the sketch.

-
Triangle

-Triangle

- -

Added In API Version 01.00.00

- -

Use the Triangle tool to add a new KimonoShapeTriangle to the sketch.

-
Vector

-Vector

- -

Added In API Version 01.00.00

- -

Use the Vector tool to add a new KimonoShapeVector to the sketch.

-
Bezier

-Bezier

- -

Added In API Version 01.00.00

- -

Use the Bezier tool to add a new KimonoShapeBezier to the sketch.

-
Text

-Text

- -

Added In API Version 01.00.00

- -

Use the Text tool to add a new KimonoShapeText to the sketch.

-

- - ---- - - -##Kimono - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Holds a set of shared utilities that are used across the Kimono classes. -

MethodsSummary
CharIsNumber

- -

CharIsNumber (System.Char)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given character is a number character.

- -

ParameterSummary
c

-C.

-

- -

Returns

- -

true, if is character is a number, false otherwise.

-
CharIsLetter

- -

CharIsLetter (System.Char)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given character is a letter character.

- -

ParameterSummary
c

-C.

-

- -

Returns

- -

true, if is letter was chared, false otherwise.

-
IncrementName

- -

IncrementName (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Increments the name by appending a number to the end or incrementing an existing number count.

- -

ParameterSummary
name

-Name.

-

- -

Returns

- -

The name.

-
CloneSKPoint

- -

CloneSKPoint (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clones the given SKPoint.

- -

ParameterSummary
point

-The SKPoint to clone.

-

- -

Returns

- -

A clone of the given point.

-

- - ---- - - -##PortfolioEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Portfolio event delegate. - ---- - - -##SketchEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Sketch event delegate. - ---- - - -##StyleEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Style event delegate. - ---- - - -##ShapeEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Shape event delegate. - ---- - - -##ToolEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Tool event delegate. - ---- - - -##SkiaPointEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Skia point event delegate. - ---- - - -##GroupEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Group event delegate. - ---- - - -##ColorEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Color event delegate. - ---- - - -##SkiaColorEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Skia color event delegate. - ---- - - -##GradientEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Gradient event delegate. - ---- - - -##HandleEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Handle event delegate. - ---- - - -##PropertyEventDelegate - -###Namespace - -[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) - -###Added In API Version - -01.00.00 - -###Summary - -Property event delegate. - ---- - - -##KimonoPortfolio - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -A Kimono Portfolio holds a collection of `KimonoSketches`, `KimonoStyles` and `KimonoColors` that define a given Kimono Designer project. -

FieldsSummary
_selectedSketch

-_selectedSketch

- -

Added In API Version 01.00.00

- -

The currently selected sketch.

-
NewSketchNumber

-NewSketchNumber

- -

Added In API Version 01.00.00

- -

Holds the number that will be assigned to the next new KimonoSketch created in this portfolio.

-

- -

PropertiesSummary
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
ElementName

- -

ElementName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the element as it will be called in generated source code.

- -

Return Value

- -

The name of the element.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
Namespace

- -

Namespace

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the namespace.

- -

Return Value

- -

The namespace.

-
Author

- -

Author

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the author.

- -

Return Value

- -

The author.

-
Copyright

- -

Copyright

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the copyright.

- -

Return Value

- -

The copyright.

-
Sketches

- -

Sketches

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the sketches.

- -

Return Value

- -

The sketches.

-
Styles

- -

Styles

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the styles.

- -

Return Value

- -

The styles.

-
Colors

- -

Colors

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the colors.

- -

Return Value

- -

The colors.

-
Gradients

- -

Gradients

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the gradients.

- -

Return Value

- -

The gradients.

-
Properties

- -

Properties

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the properties.

- -

Return Value

- -

The properties.

-
SelectedSketch

- -

SelectedSketch

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the selected sketch.

- -

Return Value

- -

The selected sketch.

-

- -

MethodsSummary
KimonoPortfolio

- -

KimonoPortfolio (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPortfolio class.

- -

ParameterSummary
initialize

-If true, the new instance will be initialized with the default values.

-

- -

Remarks

- -

initialize is set to false when a clone is being made of given KimonoPortfolio.

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
FindSketch

- -

FindSketch (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the given KimonoSketch by its Unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoSketch if found, else null.

-
FindColor

- -

FindColor (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the given KimonoColor by its unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoColor if found, else null.

-
FindProperty

- -

FindProperty (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the given KimonoProperty by its unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoProperty if founs, else null.

-
FindGradient

- -

FindGradient (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the gradient by its unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoGradient if found, else null.

-
FindStyle

- -

FindStyle (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the given KimonoStyle by its Unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoStyle if found, else null.

-
AddNewSketch

- -

AddNewSketch ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the a new KimonoSketch to this portfolio.

-
DuplicateSelectedSketch

- -

DuplicateSelectedSketch ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the selected sketch.

-
DeleteSelectedSketch

- -

DeleteSelectedSketch ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the selected sketch.

-
AddNewGradient

- -

AddNewGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the new gradient.

- -

Returns

- -

The new gradient.

-
AddNewColor

- -

AddNewColor ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new KimonoColor to this portfolio.

- -

Returns

- -

The new KimonoColor.

-
AddNewColor

- -

AddNewColor (SkiaSharp.SKColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new KimonoColor to this portfolio based off of a given SKColor.

- -

ParameterSummary
baseColor

-Base color.

-

- -

Returns

- -

The new KimonoColor.

-
AddPropertyBoolean

- -

AddPropertyBoolean ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new boolean property.

- -

Returns

- -

The new KimonoPropertyBoolean.

-
AddPropertyColor

- -

AddPropertyColor ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new color property.

- -

Returns

- -

The new KimonoPropertyColor.

-
AddPropertyGradient

- -

AddPropertyGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new gradient property.

- -

Returns

- -

The new KimonoPropertyGradient.

-
AddPropertyNumber

- -

AddPropertyNumber ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new number property.

- -

Returns

- -

The new KimonoPropertyNumber.

-
AddPropertyRect

- -

AddPropertyRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new rect property.

- -

Returns

- -

The new KimonoPropertyRect.

-
AddPropertyStyle

- -

AddPropertyStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new style property.

- -

Returns

- -

The new KimonoPropertyStyle.

-
AddPropertyText

- -

AddPropertyText ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new text property.

- -

Returns

- -

The new KimonoPropertyText.

-
AddNewProperty

- -

AddNewProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given KimonoProperty to this portfolio

- -

ParameterSummary
property

-The KimonoProperty to add.

-

-
DuplicateColor

- -

DuplicateColor (KimonoCore.KimonoColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the given KimonoColor and adds it to the portfolio's collection of colors.

- -

ParameterSummary
color

-The KimonoColor to duplicate.

-

-
DuplicateProperty

- -

DuplicateProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the property.

- -

ParameterSummary
property

-The KimonoProperty to duplicate.

-

- -

Returns

- -

The new KimonoProperty.

-
DuplicateGradient

- -

DuplicateGradient (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the gradient.

- -

ParameterSummary
gradient

-The KimonoGradient to duplicate.

-

-
DeleteColor

- -

DeleteColor (KimonoCore.KimonoColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given KimonoColor from the portfolio.

- -

ParameterSummary
color

-The KimonoColor to delete.

-

-
DeleteGradient

- -

DeleteGradient (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given gradient from the portfolio.

- -

ParameterSummary
gradient

-The KimonoGradient to delete.

-

-
DeleteProperty

- -

DeleteProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given property.

- -

ParameterSummary
property

-The KimonoProperty to delete.

-

-
AddNewStyle

- -

AddNewStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the a new KimonoStyle to the portfolio.

-
DuplicateStyle

- -

DuplicateStyle (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the given KimonoStyle adding it to the portfolio's collection of styles.

- -

ParameterSummary
style

-The KimonoStyle to duplicate.

-

-
ConvertSelectedShapeToStyle

- -

ConvertSelectedShapeToStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Takes the custom KimonoStyle of the currently selected KimonoShape, converts it to a named, shared style and adds it to the portfolio's collection of styles.

-
DeleteStyle

- -

DeleteStyle (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given KimonoStyle from the portfolio's collection of styles.

- -

ParameterSummary
style

-Style.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCSharpUsingStatements

- -

ToCSharpUsingStatements (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Builds the C# using statements.

- -

ParameterSummary
outputOS

-The CodeOutputOS to write code for.

-
outputLibrary

-Output library.

-

- -

Returns

- -

The required using statements based on what other features have been selected.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCSharpKimono

- -

ToCSharpKimono (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this sketch to C# code using the KimonoCore library.

- -

ParameterSummary
outputOS

-The CodeOutputOS to create code for.

-
outputLanguage

-The CodeOutputLanguage to use.

-
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The sketch as source code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
RelinkColors

- -

RelinkColors ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the colors after a clone operation.

-
RelinkGradient

- -

RelinkGradient (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the gradient after a clone operation.

- -

ParameterSummary
gradient

-The KimonoGradient to relink.

-

-
RelinkStyle

- -

RelinkStyle (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the given KimonoStyle after a clone operation.

- -

ParameterSummary
style

-The KimonoStyle to relink.

-

-
RelinkShape

- -

RelinkShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the given KimonoShape after a clone operation.

- -

ParameterSummary
shape

-The KimonoShape to relink.

-

-
RelinkSketch

- -

RelinkSketch (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the given KimonoSketch after a clone operation.

- -

ParameterSummary
sketch

-The KimonoSketch to relink.

-

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

A deep clone of this KimonoPortfolio.

-
RaisePropertyModified

- -

RaisePropertyModified (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the property modified event.

- -

ParameterSummary
property

-The KimonoProperty that was modified.

-

-
RaiseGradientsModified

- -

RaiseGradientsModified (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the gradients modified event.

- -

ParameterSummary
gradient

-The KimonoGradient that was modified.

-

-
RaiseRequestNewUndoPoint

- -

RaiseRequestNewUndoPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the request new undo point event.

-
RaiseSketchesModified

- -

RaiseSketchesModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the sketches modified event.

-
RaiseSelectedSketchWillChange

- -

RaiseSelectedSketchWillChange (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the selected sketch will change event.

- -

ParameterSummary
sketch

-The KimonoSketch that will change.

-

-
RaiseSelectedSketchDidChange

- -

RaiseSelectedSketchDidChange (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the selected sketch did change event.

- -

ParameterSummary
sketch

-The KimonoSketch that did change.

-

-
RaiseStylesModified

- -

RaiseStylesModified (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the styles modified event.

- -

ParameterSummary
style

-The KimonoStyle that was modified.

-

-
RaiseSelectedShapeChanged

- -

RaiseSelectedShapeChanged (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the selected shape changed event.

- -

ParameterSummary
selected

-The new KimonoShape that was selected.

-

-
RaiseColorsModified

- -

RaiseColorsModified (KimonoCore.KimonoColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the colors modified event.

- -

ParameterSummary
color

-The KimonoColor that was modified.

-

-

- -

EventsSummary
RequestNewUndoPoint

- -

RequestNewUndoPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when a new undo point is requested.

-
SketchesModified

- -

SketchesModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when sketches collection is modified.

-
SelectedSketchWillChange

- -

SelectedSketchWillChange

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when selected sketch will change.

-
SelectedSketchDidChange

- -

SelectedSketchDidChange

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when selected sketch did change.

-
StylesModified

- -

StylesModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when styles collection is modified.

-
SelectedShapeChanged

- -

SelectedShapeChanged

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when selected shape changed.

-
ColorsModified

- -

ColorsModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when colors collection is modified.

-
GradientsModified

- -

GradientsModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when gradients collection is modified.

-
PropertyModified

- -

PropertyModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when property collection is modified.

-

- - ---- - - -##KimonoUndoHandler - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Handles the undo/redo state for a `KimonoDesignSurface`. -

PropertiesSummary
MaximumUndoPoints

- -

MaximumUndoPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the maximum undo points.

- -

Return Value

- -

The maximum undo points.

-
UndoStack

- -

UndoStack

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the undo stack.

- -

Return Value

- -

The undo stack.

-
RedoStack

- -

RedoStack

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the redo stack.

- -

Return Value

- -

The redo stack.

-
CanUndo

- -

CanUndo

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the user can undo their last action.

- -

Return Value

- -

true if can undo; otherwise, false.

-
CanRedo

- -

CanRedo

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the user can redo their last action.

- -

Return Value

- -

true if can redo; otherwise, false.

-

- -

MethodsSummary
KimonoUndoHandler

- -

KimonoUndoHandler ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoUndoHandler class.

-
PushUndoPoint

- -

PushUndoPoint (KimonoCore.KimonoPortfolio)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Pushes the undo point onto the stack.

- -

ParameterSummary
portfolio

-The current state of the KimonoPortfolio.

-

-
ReplaceLastUndoPoint

- -

ReplaceLastUndoPoint (KimonoCore.KimonoPortfolio)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Replaces the last undo point with the one being passed in.

- -

ParameterSummary
portfolio

-The current state of the KimonoPortfolio.

-

-
PopUndoPoint

- -

PopUndoPoint (KimonoCore.KimonoPortfolio)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Pops the undo point off the stack.

- -

ParameterSummary
portfolio

-The current state of the KimonoPortfolio.

-

- -

Returns

- -

The prior state of the KimonoPortfolio.

-
PopRedoPoint

- -

PopRedoPoint (KimonoCore.KimonoPortfolio)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Pops the redo point off the stack.

- -

ParameterSummary
portfolio

-The current state of the KimonoPortfolio.

-

- -

Returns

- -

The previous state of the KimonoPortfolio.

-
RaiseUndoStateChanged

- -

RaiseUndoStateChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the undo state changed event.

-

- -

EventsSummary
UndoStateChanged

- -

UndoStateChanged

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when undo state changed.

-

- - ---- - - -##KimonoShape - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the based shape that all other Kimono Shape types will inherit from. -

FieldsSummary
_name

-_name

- -

Added In API Version 01.00.00

- -

The default name of the shape.

-
_style

-_style

- -

Added In API Version 01.00.00

- -

The default, custom KimonoStyle that is attached to the shape.

-
_visible

-_visible

- -

Added In API Version 01.00.00

- -

The visibility of the shape.

-

- -

PropertiesSummary
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
ElementName

- -

ElementName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the element as it will be called in generated source code.

- -

Return Value

- -

The name of the element.

-
Style

- -

Style

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the style.

- -

Return Value

- -

The KimonoStyle that will be used to draw this shape.

-
ControlPoints

- -

ControlPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the control points that define the path of the shape.

- -

Return Value

- -

A collection of KimonoHandle objects.

-
Visible

- -

Visible

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShape is visible.

- -

Return Value

- -

true if visible; otherwise, false.

-
IsEditable

- -

IsEditable

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoShape is editable.

- -

Return Value

- -

true if is editable; otherwise, false.

- -

Remarks

- -

An "Editable Shape" is one that is composed of a set of data points (such as KimonoVector or KimonoBezier) or a group of objects (such as KimonoShapeGroup).

-
LayerDepth

- -

LayerDepth

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the layer depth from the bottom to the top controlling how shapes are overlapping on the design surface.

- -

Return Value

- -

The layer depth.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-
PropertyConnections

- -

PropertyConnections

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the list of KimonoProperty objects connected to the various KimonoPropertyConnectionPoints that will need to be evaulated before drawing this KimonoShape.

- -

Return Value

- -

The property connections.

-

- -

MethodsSummary
KimonoShape

- -

KimonoShape ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShape class.

-
KimonoShape

- -

KimonoShape (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShape class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShape

- -

KimonoShape (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShape class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
AddPropertyConnection

- -

AddPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Connects the given KimonoProperty to the given KimonoPropertyConnectionPoint on this KimonoShape.

- -

ParameterSummary
connectionPoint

-The KimonoPropertyConnectionPoint to connect to.

-
property

-The KimonoProperty to connect.

-

-
RemovePropertyConnection

- -

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the property connection.

- -

ParameterSummary
connection

-The KimonoPropertyConnection to remove.

-

-
RemoveProperty

- -

RemoveProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes any connection using this property.

- -

ParameterSummary
property

-The KimonoProperty to remove.

-

-
EvaluateConnectedProperties

- -

EvaluateConnectedProperties ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluates all of the KimonoProperty objects attached to this KimonoShape by executling their Obi Scripts and updating the values with the results.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
StartEditing

- -

StartEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Places the shape in the editing mode.

-
EndEditing

- -

EndEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Ends the editing mode.

-
UncoupleDeletedStyle

- -

UncoupleDeletedStyle (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Uncouples the deleted style from the shape.

- -

ParameterSummary
deletedStyle

-The KimonoStyle to delete.

-

-
ConformGradientToShape

- -

ConformGradientToShape (KimonoCore.KimonoGradient, SkiaSharp.SKPaint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Conforms the gradient to shape by fitting it to the bounds of the shape.

- -

ParameterSummary
gradient

-The KimonoGradient to conform.

-
paint

-The SKPaint that the gradient is being attached to.

-

-
ToVector

- -

ToVector ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a vector.

- -

Returns

- -

The shape as a KimonoVector.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
StyleFillPaintForCode

- -

StyleFillPaintForCode (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the style fill paint for code.

-
StyleFramePaintForCode

- -

StyleFramePaintForCode (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the style frame paint for code.

-
ConformedFillGradientCode

- -

ConformedFillGradientCode (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Conforms the attached gradient to the shapes bounds for code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The fill gradient conformed in code.

-
ConformedFrameGradientCode

- -

ConformedFrameGradientCode (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Conforms the attached gradient to the shapes bounds for code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The frame gradient conformed in code.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
CloneAttachedStyle

- -

CloneAttachedStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clones the attached style.

- -

Returns

- -

A duplicate KimonoStyle.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone of this shape as a base KimonoBounds.

-

- - ---- - - -##KimonoShapeArrow - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws either an outlined or single line arrow with heads on one or both ends. -

PropertiesSummary
HasStartHead

- -

HasStartHead

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeArrow has start head.

- -

Return Value

- -

true if has start head; otherwise, false.

-
HasEndHead

- -

HasEndHead

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeArrow has end head.

- -

Return Value

- -

true if has end head; otherwise, false.

-
HeadInnerRatio

- -

HeadInnerRatio

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the head inner ratio.

- -

Return Value

- -

The head inner ratio.

-
HeadOuterRatio

- -

HeadOuterRatio

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the head outer ratio.

- -

Return Value

- -

The head outer ratio.

-
IsStreamlined

- -

IsStreamlined

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeArrow is streamlined.

- -

Return Value

- -

true if is streamlined; otherwise, false.

- -

Remarks

- -

A Streamlined Arrow, is drawn as a single line.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-

- -

MethodsSummary
KimonoShapeArrow

- -

KimonoShapeArrow ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeArrow class.

-
KimonoShapeArrow

- -

KimonoShapeArrow (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeArrow class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeArrow

- -

KimonoShapeArrow (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeArrow class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the arrow to a path.

- -

Returns

- -

The the arrow as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the arrow into the specified Skia canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
GrowBounds

- -

GrowBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Grows the bounds of the arrow.

- -

ParameterSummary
point

-The SKPoint containing the bounds adjustment.

-

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds of the arrow to a new location.

- -

ParameterSummary
point

-The SKPoint specifying the new location of the bounds.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone of the KimonoArrow.

-

- - ---- - - -##KimonoShapeBezier - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -A Kimono Bezier is a collection of control and end points that define the quad sections of a bezier shape to be drawn using SkiaSharp. -

PropertiesSummary
Points

- -

Points

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the points that define the shape.

- -

Return Value

- -

The points.

-
Closed

- -

Closed

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeVector is closed.

- -

Return Value

- -

true if closed; otherwise, false.

-
IsEditable

- -

IsEditable

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoShapeVector is editable.

- -

Return Value

- -

true if is editable; otherwise, false.

-
LastPoint

- -

LastPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the last point in the collection of control points.

- -

Return Value

- -

The last point.

-

- -

MethodsSummary
KimonoShapeBezier

- -

KimonoShapeBezier ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeBezier class.

-
KimonoShapeBezier

- -

KimonoShapeBezier (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeBezier class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeBezier

- -

KimonoShapeBezier (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeBezier class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
RecalculateVectorBounds

- -

RecalculateVectorBounds ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Recalculates the vector bounds to encompas all of the data points that define the shape.

-
AddPoint

- -

AddPoint (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a point to the shape.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-

-
AddPoint

- -

AddPoint (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the point to the shape.

- -

ParameterSummary
controlX

-Control x.

-
controlY

-Control y.

-
endX

-End x.

-
endY

-End y.

-

-
AddPoint

- -

AddPoint (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given point to the shape.

- -

ParameterSummary
point

-The new SKPoint to add.

-

-
AddHandlesForPoint

- -

AddHandlesForPoint (System.Int32, KimonoCore.KimonoBezierPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the handles for the given bezier point.

- -

ParameterSummary
index

-The index of the KimonoBezierPoint that handles are being created for.

-
bezierPoint

-The KimonoBezierPoint that is getting handles.

-

-
MoveLastPoint

- -

MoveLastPoint (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the last point added to the new position.

- -

ParameterSummary
point

-The SKPoint for the new position.

-

-
RemovePoint

- -

RemovePoint (System.Int32)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the given point.

- -

ParameterSummary
n

-The index of the point ot remove.

-

-
ApplyMoveAndScale

- -

ApplyMoveAndScale ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the move and scale amount to the data point that make up the shape.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the shape into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
PointInBound

- -

PointInBound (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Tests to see if the given point is inside the bounds of the shape.

- -

ParameterSummary
point

-The SKPoint to test.

-

- -

Returns

- -

true, if in bound was pointed, false otherwise.

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds of the shape to a new location.

- -

ParameterSummary
point

-The SKPoint to drag the bounds to.

-

-
BoundsChanged

- -

BoundsChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the bounds of the shape being changed.

-
StartEditing

- -

StartEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Places the shape into the editing mode where the user can adjust the individual data points that define the shape.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeVector.

-

- - ---- - - -##KimonoShapeGroup - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -A `KimonoShapeGroup` holds a collection of `KimonoShapes` that can be acted upon as a group. -

FieldsSummary
ShapeUnderConstruction

-ShapeUnderConstruction

- -

Added In API Version 01.00.00

- -

The shape under construction.

-
_selectedShape

-_selectedShape

- -

Added In API Version 01.00.00

- -

The currently selected shape.

-
Dragging

-Dragging

- -

Added In API Version 01.00.00

- -

Marks if the group itself is being moved be the user.

-
IgnoreDrag

-IgnoreDrag

- -

Added In API Version 01.00.00

- -

If true, the next drag event will be ignored.

-
PerformingDrag

-PerformingDrag

- -

Added In API Version 01.00.00

- -

If true, the user is performing a drag operation.

-
ToolDownAt

-ToolDownAt

- -

Added In API Version 01.00.00

- -

The last point that a KimonoTool went down on the sketch's Design Surface.

-
_isMaskedGroup

-_isMaskedGroup

- -

Added In API Version 01.00.00

- -

If true, the top most shape in the group will act as a mask for the shapes below it.

-

- -

PropertiesSummary
Parent

- -

Parent

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the parent KimonoSketch or KimonoShapeGroup that this KimonoShapeGroup belongs to.

- -

Return Value

- -

The parent KimonoSketch or KimonoShapeGroup.

-
ParentSketch

- -

ParentSketch

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the parent sketch by scanning backwards through the chain of parent objects until a KimonoSketch is reached.

- -

Return Value

- -

The parent KimonoSketch.

-
Path

- -

Path

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the full path from this group back to the parent KimonoSketch.

- -

Return Value

- -

The path representing the nesting level of this group.

-
Shapes

- -

Shapes

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the shapes.

- -

Return Value

- -

The shapes.

-
SelectedShape

- -

SelectedShape

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the selected shape.

- -

Return Value

- -

The selected shape.

-
DeeplySelectedShape

- -

DeeplySelectedShape

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the deepest selected shape in a chain of groups.

- -

Return Value

- -

The deeply selected shape.

-
DeeplySelectedGroup

- -

DeeplySelectedGroup

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the deepest selected group in a chain of groups that is in the edit mode.

- -

Return Value

- -

The deeply selected group.

-
GroupType

- -

GroupType

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the type of the group.

- -

Return Value

- -

The type of the group as a KimonoShapeGroupType.

-
Style

- -

Style

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the style of this group.

- -

Return Value

- -

The style as a KimonoStyle.

-
Visible

- -

Visible

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeGroup is visible.

- -

Return Value

- -

true if visible; otherwise, false.

-
IsEditable

- -

IsEditable

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoShapeGroup is editable.

- -

Return Value

- -

true if is editable; otherwise, false.

-
SelectedShapeAtBottom

- -

SelectedShapeAtBottom

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selected shape is at the bottom.

- -

Return Value

- -

true if selected shape at bottom; otherwise, false.

-
SelectedShapeAtTop

- -

SelectedShapeAtTop

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether the selected shape is at the top.

- -

Return Value

- -

true if selected shape at top; otherwise, false.

-
IsBooleanConstruct

- -

IsBooleanConstruct

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeGroup is a boolean construct.

- -

Return Value

- -

true if is boolean construct; otherwise, false.

-
BooleanOperation

- -

BooleanOperation

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the boolean operation that will be applied to this group of objects.

- -

Return Value

- -

The boolean operation as a SKPathOp.

-
Mask

- -

Mask

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the KimonoShape that is acting as a mask for this group.

- -

Return Value

- -

The mask as a KimonoShape.

-
IsMaskedGroup

- -

IsMaskedGroup

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeGroup is masked group.

- -

Return Value

- -

true if is masked group; otherwise, false.

-

- -

MethodsSummary
KimonoShapeGroup

- -

KimonoShapeGroup (System.Object)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeGroup class.

- -

ParameterSummary
parent

-The parent KimonoSketch or KimonoShapeGroup.

-

-
KimonoShapeGroup

- -

KimonoShapeGroup (System.Object, System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeGroup class.

- -

ParameterSummary
parent

-Parent.

-
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeGroup

- -

KimonoShapeGroup (System.Object, System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeGroup class.

- -

ParameterSummary
parent

-Parent.

-
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize (System.Object)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize the specified parent.

- -

ParameterSummary
parent

-Parent.

-

- -

Returns

- -

The initialize.

-
FindShape

- -

FindShape (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds a given shape by its Unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The KimonoShape if found, else null.

-
RecalculateGroupBounds

- -

RecalculateGroupBounds ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Recalculates the group bounds to encompass every KimonoShape inside this group.

-
ReturnToSketch

- -

ReturnToSketch ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns to base parent KimonoSketch for this group.

-
SelectShape

- -

SelectShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Selects the given KimonoShape.

- -

ParameterSummary
shape

-Shape.

-

-
RecalculateLayerDepths

- -

RecalculateLayerDepths ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Recalculates the layer depths.

- -

Remarks

- -

Layer depths are used to maintain the front to back order of the KimonoShapes that for the sketch.

-
MoveSelectedShapeToBottom

- -

MoveSelectedShapeToBottom ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape to bottom.

-
MoveSelectedShapeBackwards

- -

MoveSelectedShapeBackwards ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape backwards.

-
MoveSelectedShapeToTop

- -

MoveSelectedShapeToTop ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape to top.

-
MoveSelectedShapeForwards

- -

MoveSelectedShapeForwards ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the selected shape forwards.

-
AlignAllTop

- -

AlignAllTop ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Aligns all shapes in the group at the top.

-
AlignAllBottom

- -

AlignAllBottom ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Aligns all shapes in the group at the bottom.

-
AlignAllLeft

- -

AlignAllLeft ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Aligns all shapes in the group to the left.

-
AlignAllRight

- -

AlignAllRight ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Aligns all shapes in the group to the right.

-
AlignAllCenter

- -

AlignAllCenter ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Centers all shapes in the group.

-
AlignAllCenterHorizontal

- -

AlignAllCenterHorizontal ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Center horizontal all shapes in the group.

-
AlignAllCenterVertical

- -

AlignAllCenterVertical ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Center vertical all shapes in the group.

-
DeleteColor

- -

DeleteColor (KimonoCore.KimonoColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given KimonoColor from this group.

- -

ParameterSummary
color

-The KimonoColor to delete.

-

-
DeleteGradient

- -

DeleteGradient (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the given gradient from the group.

- -

ParameterSummary
gradient

-The KimonoGradient to delete.

-

-
AddShape

- -

AddShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given KimonoShape to the group if it isn't already a part of the group.

- -

ParameterSummary
shape

-The KimonoShape to add.

-

-
DuplicateSelectedShape

- -

DuplicateSelectedShape ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the selected shape.

-
RemoveShape

- -

RemoveShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the given KimonoShape from the group.

- -

ParameterSummary
shape

-Shape.

-

-
DeleteSelectedShape

- -

DeleteSelectedShape ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the selected shape.

-
ShapeInGroup

- -

ShapeInGroup (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given KimonoShape is a part of this group.

- -

ParameterSummary
shape

-The KimonoShape to test for.

-

- -

Returns

- -

true, if in shape is in the group, false otherwise.

-
DeselectAll

- -

DeselectAll ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deselects all shapes in this group.

-
GroupShapes

- -

GroupShapes ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Groups the shapes.

-
GroupShapes

- -

GroupShapes (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Groups the shapes in the parent sketch.

- -

ParameterSummary
sketch

-The parent KimonoSketch.

-

-
GroupShapes

- -

GroupShapes (KimonoCore.KimonoShapeGroup)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Groups the shapes in the parent group.

- -

ParameterSummary
group

-The parent KimonoShapeGroup.

-

-
UngroupShapes

- -

UngroupShapes ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Ungroups the shapes in this group.

-
UngroupShapes

- -

UngroupShapes (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Ungroups the shapes in the parent sketch.

- -

ParameterSummary
sketch

-The parent KimonoSketch.

-

-
UngroupShapes

- -

UngroupShapes (KimonoCore.KimonoShapeGroup)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Ungroups the shapes in the parent group.

- -

ParameterSummary
group

-The parent KimonoShapeGroup.

-

-
DuplicateShapes

- -

DuplicateShapes ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the shapes in a selection group.

-
DuplicateShapes

- -

DuplicateShapes (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the shapes in this selection group into the parent sketch.

- -

ParameterSummary
sketch

-The parent KimonoSketch.

-

-
DuplicateShapes

- -

DuplicateShapes (KimonoCore.KimonoShapeGroup)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the shapes in this selection group into the parent group.

- -

ParameterSummary
group

-The parent KimonoShapeGroup.

-

-
DeleteShapes

- -

DeleteShapes ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the shapes in this selection group.

-
DeleteShapes

- -

DeleteShapes (KimonoCore.KimonoSketch)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the shapes in this selection group from the parent sketch.

- -

ParameterSummary
sketch

-The parent KimonoSketch.

-

-
DeleteShapes

- -

DeleteShapes (KimonoCore.KimonoShapeGroup)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the shapes in this selection group from the parent group.

- -

ParameterSummary
group

-The parent KimonoShapeGroup.

-

-
ApplyMoveAndScale

- -

ApplyMoveAndScale ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the move and scale adjustments to all KimonoShapes inside this group.

-
RemovePropertyConnection

- -

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the property connection.

- -

ParameterSummary
connection

-The KimonoPropertyConnection to remove.

-

-
RemoveProperty

- -

RemoveProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes any connection using this property.

- -

ParameterSummary
property

-The KimonoProperty to remove.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the group of shapes to a path.

- -

Returns

- -

The group of shapes as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draw all the KimonoShapes that are part of this group into the given Skia canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
StartEditing

- -

StartEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Starts editing this group.

-
EndEditing

- -

EndEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Ends editing this group.

-
PointInBound

- -

PointInBound (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given point is inside the bounds of this group.

- -

ParameterSummary
point

-The SKPoint to test for.

-

- -

Returns

- -

true, if the point was in bounds, false otherwise.

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds of this group.

- -

ParameterSummary
point

-The new location as a SKPoint.

-

-
BoundsChanged

- -

BoundsChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Update the bouds of this group when they have changed from either a move or a drag operation.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
RelinkShape

- -

RelinkShape (KimonoCore.KimonoShape)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Relinks the shape after a clone operation.

- -

ParameterSummary
shape

-The KimonoShape to relink.

-

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

A deep clone of this KimonoShapeGroup.

-
ToolDown

- -

ToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user placing the current KimonoTool down on the group's Design Surface.

- -

ParameterSummary
point

-The SKPoint where the tool went down on the Design Surface.

-
clicks

-The number of time the user clicked/tapped the tool down on the Design Surface.

-
multiSelect

-If true, the user has started a multi-shape select process.

-

-

- - ---- - - -##KimonoShapeGroupType - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the type of a `KimonoShapeGroup`. -

FieldsSummary
Selection

-Selection

- -

Added In API Version 01.00.00

- -

The group is a current active selection.

-
DragSelect

-DragSelect

- -

Added In API Version 01.00.00

- -

The group is a drag to select selection that is underway.

-
Collection

-Collection

- -

Added In API Version 01.00.00

- -

The group is a collection of shape that have been grouped together and are treated as a single object in the editor.

-

- - ---- - - -##KimonoShapeLine - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a line on the design surface. -

MethodsSummary
KimonoShapeLine

- -

KimonoShapeLine ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeLine class.

-
KimonoShapeLine

- -

KimonoShapeLine (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeLine class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeLine

- -

KimonoShapeLine (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeLine class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the line into the given Skia canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone of the KimonoLine.

-

- - ---- - - -##KimonoShapeOval - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws an oval into the Design Surface. -

MethodsSummary
KimonoShapeOval

- -

KimonoShapeOval ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeOval class.

-
KimonoShapeOval

- -

KimonoShapeOval (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeOval class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeOval

- -

KimonoShapeOval (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeOval class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draw the oval into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoOval.

-

- - ---- - - -##KimonoShapePolygon - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a multi-sided polygon into the Design Surface. -

PropertiesSummary
NumberOfSides

- -

NumberOfSides

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the number of sides.

- -

Return Value

- -

The number of sides.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-

- -

MethodsSummary
KimonoShapePolygon

- -

KimonoShapePolygon ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapePolygon class.

-
KimonoShapePolygon

- -

KimonoShapePolygon (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapePolygon class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapePolygon

- -

KimonoShapePolygon (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapePolygon class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
MakeSidePoints

- -

MakeSidePoints (System.Double, System.Int32, SkiaSharp.SKRect)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Makes the star points.

- -

ParameterSummary
startTheta

-Start theta.

-
numPoints

-Number points.

-
skip

-Skip.

-
rect

-Rect.

-

- -

Returns

- -

The star points.

- -

Remarks

- -

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the polygon into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoPloygon.

-

- - ---- - - -##KimonoShapeRect - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a rectangle into the Design Surface. -

MethodsSummary
KimonoShapeRect

- -

KimonoShapeRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRect class.

-
KimonoShapeRect

- -

KimonoShapeRect (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeRect

- -

KimonoShapeRect (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the rectangle into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoShapeRoundRect - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a rounded rectangle into the Design Surface. -

PropertiesSummary
CornerRadius

- -

CornerRadius

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the corner radius.

- -

Return Value

- -

The corner radius.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-

- -

MethodsSummary
KimonoShapeRoundRect

- -

KimonoShapeRoundRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRoundRect class.

-
KimonoShapeRoundRect

- -

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRoundRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeRoundRect

- -

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRoundRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
cornerRadius

-Corner radius.

-

-
KimonoShapeRoundRect

- -

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRoundRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
KimonoShapeRoundRect

- -

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeRoundRect class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
cornerRadius

-Corner radius.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the round rectangle into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeRoundRect.

-

- - ---- - - -##KimonoShapeStar - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a multi-sided star shape into the Design Surface. -

PropertiesSummary
NumberOfPoints

- -

NumberOfPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the number of points.

- -

Return Value

- -

The number of points.

-
SkipPoints

- -

SkipPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the skip points.

- -

Return Value

- -

The skip points.

-
DepthOffset

- -

DepthOffset

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the depth offset for the individual points.

- -

Return Value

- -

The depth offset.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-

- -

MethodsSummary
KimonoShapeStar

- -

KimonoShapeStar ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeStar class.

-
KimonoShapeStar

- -

KimonoShapeStar (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeStar class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeStar

- -

KimonoShapeStar (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeStar class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
MakeStarPoints

- -

MakeStarPoints (System.Double, System.Int32, System.Int32, SkiaSharp.SKRect, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Makes the star points.

- -

ParameterSummary
startTheta

-Start theta.

-
numPoints

-Number points.

-
skip

-Skip.

-
rect

-Rect.

-

- -

Returns

- -

The star points.

- -

Remarks

- -

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

-
CalculateConcaveRadius

- -

CalculateConcaveRadius (System.Int32, System.Int32)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Calculates the concave radius.

- -

ParameterSummary
numPoints

-Number points.

-
skip

-Skip.

-

- -

Returns

- -

The concave radius.

- -

Remarks

- -

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

-
FindIntersection

- -

FindIntersection (SkiaSharp.SKPoint, SkiaSharp.SKPoint, SkiaSharp.SKPoint, SkiaSharp.SKPoint, System.Boolean@, System.Boolean@, SkiaSharp.SKPoint@, SkiaSharp.SKPoint@, SkiaSharp.SKPoint@)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the intersection.

- -

ParameterSummary
p1

-P1.

-
p2

-P2.

-
p3

-P3.

-
p4

-P4.

-
lines_intersect

-If set to true lines intersect.

-
segments_intersect

-If set to true segments intersect.

-
intersection

-Intersection.

-
close_p1

-Close p1.

-
close_p2

-Close p2.

-

- -

Remarks

- -

This code adapted from http://csharphelper.com/blog/2014/08/determine-where-two-lines-intersect-in-c/ by Rod Stephens.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the star into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToVector

- -

ToVector ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the star into a vector.

- -

Returns

- -

The KimonoShapeVector version of the star.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeStar.

-

- - ---- - - -##KimonoShapeState - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Holds the current state of a `KimonoShape` while it is being edited by the user. -

FieldsSummary
Unselected

-Unselected

- -

Added In API Version 01.00.00

- -

The shape is unselected.

-
Selected

-Selected

- -

Added In API Version 01.00.00

- -

The shape is being selected.

-
Editing

-Editing

- -

Added In API Version 01.00.00

- -

The shape is in the edit mode and individual control points can be added, deleted, moved or adjusted.

-
Finalizing

-Finalizing

- -

Added In API Version 01.00.00

- -

The shape is leaving the edit mode and needs to be completed.

-
Constructing

-Constructing

- -

Added In API Version 01.00.00

- -

The shape is in the process of being built. For example, a set of shapes being added to a group.

-
Grouping

-Grouping

- -

Added In API Version 01.00.00

- -

The shape is being added to a group.

-

- - ---- - - -##KimonoShapeText - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a block of text into the Design Surface within the specifid bounds of this shape. -

PropertiesSummary
Text

- -

Text

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text.

- -

Return Value

- -

The text.

-
FontMetrics

- -

FontMetrics

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the font metrics.

- -

Return Value

- -

The font metrics.

-
IsLinearText

- -

IsLinearText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeText is linear text.

- -

Return Value

- -

true if is linear text; otherwise, false.

-
IsVerticalText

- -

IsVerticalText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeText is vertical text.

- -

Return Value

- -

true if is vertical text; otherwise, false.

-
StrikeThruText

- -

StrikeThruText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeText strike thru text.

- -

Return Value

- -

true if strike thru text; otherwise, false.

-
TextAlign

- -

TextAlign

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text align.

- -

Return Value

- -

The text align.

-
TextEncoding

- -

TextEncoding

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text encoding.

- -

Return Value

- -

The text encoding.

-
TextScaleX

- -

TextScaleX

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text scale x.

- -

Return Value

- -

The text scale x.

-
TextSize

- -

TextSize

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the size of the text.

- -

Return Value

- -

The size of the text.

-
TextSkewX

- -

TextSkewX

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text skew x.

- -

Return Value

- -

The text skew x.

-
Typeface

- -

Typeface

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the typeface.

- -

Return Value

- -

The typeface.

-
FontFamilyName

- -

FontFamilyName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the font family.

- -

Return Value

- -

The name of the font family.

-
TypefaceStyle

- -

TypefaceStyle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the typeface style.

- -

Return Value

- -

The typeface style.

-
UnderlineText

- -

UnderlineText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeText underline text.

- -

Return Value

- -

true if underline text; otherwise, false.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-

- -

MethodsSummary
KimonoShapeText

- -

KimonoShapeText ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeText class.

-
KimonoShapeText

- -

KimonoShapeText (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeText class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeText

- -

KimonoShapeText (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeText class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the text block into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

- -

Remarks

- -

TODO: This routine currently breaks line on characters and it needs to be adjust to break on word boundaries.

-
GrowBounds

- -

GrowBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Grows the bounds of the text block.

- -

ParameterSummary
point

-The SKPoint to adjust the bounds by.

-

- -

Remarks

- -

TODO: Changing the bounds of a text box should optionally scale the size of the text within.

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds of the text block.

- -

ParameterSummary
point

-The SKPoint with the new location of the bounds.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

- -

Remarks

- -

TODO: This routine currently breaks line on characters and it needs to be adjust to break on word boundaries.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeText.

-

- - ---- - - -##KimonoShapeTriangle - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Draws a triangle into the Design Surface. -

MethodsSummary
KimonoShapeTriangle

- -

KimonoShapeTriangle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeTriangle class.

-
KimonoShapeTriangle

- -

KimonoShapeTriangle (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeTriangle class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeTriangle

- -

KimonoShapeTriangle (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeTriangle class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the triangle into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeTriangle.

-

- - ---- - - -##KimonoShapeVector - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -A vector is a hard edged shape consisting of a set of datapoints that will be drawn into the Desing Surface. -

PropertiesSummary
Points

- -

Points

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the points that define the shape.

- -

Return Value

- -

The points.

-
Closed

- -

Closed

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoShapeVector is closed.

- -

Return Value

- -

true if closed; otherwise, false.

-
IsEditable

- -

IsEditable

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoShapeVector is editable.

- -

Return Value

- -

true if is editable; otherwise, false.

-

- -

MethodsSummary
KimonoShapeVector

- -

KimonoShapeVector ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeVector class.

-
KimonoShapeVector

- -

KimonoShapeVector (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeVector class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoShapeVector

- -

KimonoShapeVector (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShapeVector class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
RecalculateVectorBounds

- -

RecalculateVectorBounds ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Recalculates the vector bounds to encompas all of the data points that define the shape.

-
AddPoint

- -

AddPoint (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a point to the shape.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-

-
AddPoint

- -

AddPoint (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given point to the shape.

- -

ParameterSummary
point

-The new SKPoint to add.

-

-
MoveLastPoint

- -

MoveLastPoint (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the last point added to the new position.

- -

ParameterSummary
point

-The SKPoint for the new position.

-

-
RemovePoint

- -

RemovePoint (System.Int32)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the given point.

- -

ParameterSummary
n

-The index of the point ot remove.

-

-
ApplyMoveAndScale

- -

ApplyMoveAndScale ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the move and scale amount to the data point that make up the shape.

-
ToPath

- -

ToPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the current shape to a path.

- -

Returns

- -

The shape as a SKPath.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the shape into the given Skia Canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw into.

-

-
PointInBound

- -

PointInBound (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Tests to see if the given point is inside the bounds of the shape.

- -

ParameterSummary
point

-The SKPoint to test.

-

- -

Returns

- -

true, if in bound was pointed, false otherwise.

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds of the shape to a new location.

- -

ParameterSummary
point

-The SKPoint to drag the bounds to.

-

-
BoundsChanged

- -

BoundsChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the bounds of the shape being changed.

-
StartEditing

- -

StartEditing ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Places the shape into the editing mode where the user can adjust the individual data points that define the shape.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone KimonoShapeVector.

-

- - ---- - - -##KimonoProperty - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a property that can be attached to another Kimono object (such as a `KimonoColor`, `KimonoStyle` or `KimonoShape`) and be used as a local variable, global variable or a parameter or be the result of a calculation using the Obi Simple Scripting Language. -

PropertiesSummary
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name as a string.

-
Usage

- -

Usage

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the usage of this property.

- -

Return Value

- -

The KimonoPropertyUsage of this KimonoProperty.

-
IsObiScriptValue

- -

IsObiScriptValue

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoProperty is the result of an Obi Script.

- -

Return Value

- -

true if is Obi Script value; otherwise, false.

-
ObiScript

- -

ObiScript

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the obi script that will be used to calculate the value of this KimonoProperty.

- -

Return Value

- -

The obi script.

-

- -

MethodsSummary
KimonoProperty

- -

KimonoProperty ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoProperty class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToRect

- -

ToRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a SKRect.

- -

Returns

- -

The SKRect value.

-
ToFloat

- -

ToFloat ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a float.

- -

Returns

- -

The float value.

-
ToInt

- -

ToInt ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to an int.

- -

Returns

- -

The int value.

-
ToStyle

- -

ToStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoStyle.

- -

Returns

- -

The KimonoStyle value.

-
ToBool

- -

ToBool ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a bool.

- -

Returns

- -

The bool value.

-
ToColor

- -

ToColor ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoColor.

- -

Returns

- -

The color.

-
ToGradient

- -

ToGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoGradient.

- -

Returns

- -

The gradient.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyUsage - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines how a `KimonoProperty` is used when it is attached to a `KimonoShape`, `KimonoSketch` or `KimonoPortfolio`. -

FieldsSummary
LocalVariable

-LocalVariable

- -

Added In API Version 01.00.00

- -

The given KimonoProperty will be used as a local variable in the generated code for a Kimono object.

-
GlobalVariable

-GlobalVariable

- -

Added In API Version 01.00.00

- -

The given KimonoProperty will be used as a global variable in the generated code for a Kimono object.

-
Parameter

-Parameter

- -

Added In API Version 01.00.00

- -

The given KimonoProperty will be used as a passed parameter in the generated code for a Kimono object.

-

- - ---- - - -##KimonoPropertyConnectionPoint - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the point that a `KimonoProperty` value can be connected to another Kimono object such as the `Top` coordinate of a `KimonoShape`. -

FieldsSummary
Undefined

-Undefined

- -

Added In API Version 01.00.00

- -

The connection point hasn't been defined.

-
Rect

-Rect

- -

Added In API Version 01.00.00

- -

The rectangle that defines the KimonoShape Bounds.

-
Top

-Top

- -

Added In API Version 01.00.00

- -

The Top coordinate of a KimonoShape Bounds.

-
Left

-Left

- -

Added In API Version 01.00.00

- -

The Left coordinate of a KimonoShape Bounds.

-
Bottom

-Bottom

- -

Added In API Version 01.00.00

- -

The Bottom coordinate of a KimonoShape Bounds.

-
Right

-Right

- -

Added In API Version 01.00.00

- -

The Right coordinate of a KimonoShape Bounds.

-
Width

-Width

- -

Added In API Version 01.00.00

- -

The Widht of a KimonoShape Bounds.

-
Height

-Height

- -

Added In API Version 01.00.00

- -

The Height of a KimonoShape Bounds.

-
RotationDegrees

-RotationDegrees

- -

Added In API Version 01.00.00

- -

The Rotational Degrees of a KimonoShape Bounds.

-
Style

-Style

- -

Added In API Version 01.00.00

- -

The KimonoStyle of a KimonoShape.

-
Visible

-Visible

- -

Added In API Version 01.00.00

- -

The visibility of a KimonoShape.

-
HasStartHead

-HasStartHead

- -

Added In API Version 01.00.00

- -

The has start head of a KimonoShapeArrow.

-
HasEndHead

-HasEndHead

- -

Added In API Version 01.00.00

- -

The has end head of a KimonoShapeArrow.

-
HeadInnerRatio

-HeadInnerRatio

- -

Added In API Version 01.00.00

- -

The head inner ratio of a KimonoShapeArrow.

-
HeadOuterRatio

-HeadOuterRatio

- -

Added In API Version 01.00.00

- -

The head outer ratio of a KimonoShapeArrow.

-
IsStreamlined

-IsStreamlined

- -

Added In API Version 01.00.00

- -

The is streamlined of a KimonoShapeArrow.

-
NumberOfSides

-NumberOfSides

- -

Added In API Version 01.00.00

- -

The number of sides of a KimonoShapePolygon.

-
CornerRadius

-CornerRadius

- -

Added In API Version 01.00.00

- -

The corner radius of a KimonoShapeRoundRect.

-
NumberOfPoints

-NumberOfPoints

- -

Added In API Version 01.00.00

- -

The number of points of a KimonoShapeStar.

-
SkipPoints

-SkipPoints

- -

Added In API Version 01.00.00

- -

The skip points of a KimonoShapeStar.

-
DepthOffset

-DepthOffset

- -

Added In API Version 01.00.00

- -

The depth offset of a KimonoShapeStar.

-
Text

-Text

- -

Added In API Version 01.00.00

- -

The text of a KimonoShapeText.

-
BaseColor

-BaseColor

- -

Added In API Version 01.00.00

- -

The base color of a KimonoColor.

-
AdjustsHue

-AdjustsHue

- -

Added In API Version 01.00.00

- -

The adjusts hue of a KimonoColor.

-
HueAdjustment

-HueAdjustment

- -

Added In API Version 01.00.00

- -

The hue adjustment of a KimonoColor.

-
AdjustsSaturation

-AdjustsSaturation

- -

Added In API Version 01.00.00

- -

The adjusts saturation of a KimonoColor.

-
SaturationAdjustment

-SaturationAdjustment

- -

Added In API Version 01.00.00

- -

The saturation adjustment of a KimonoColor.

-
AdjustsBrightness

-AdjustsBrightness

- -

Added In API Version 01.00.00

- -

The adjusts brightness of a KimonoColor.

-
BrightnessAdjustment

-BrightnessAdjustment

- -

Added In API Version 01.00.00

- -

The brightness adjustment of a KimonoColor.

-
AdjustsAlpha

-AdjustsAlpha

- -

Added In API Version 01.00.00

- -

The adjusts alpha of a KimonoColor.

-
AlphaAdjustment

-AlphaAdjustment

- -

Added In API Version 01.00.00

- -

The alpha adjustment of a KimonoColor.

-
HasFrame

-HasFrame

- -

Added In API Version 01.00.00

- -

The has frame of a KimonoStyle.

-
HasFrameBlur

-HasFrameBlur

- -

Added In API Version 01.00.00

- -

The has frame blur of a KimonoStyle.

-
FrameHorizontalBlurAmount

-FrameHorizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The frame horizontal blur amount of a KimonoStyle.

-
FrameVerticalBlurAmount

-FrameVerticalBlurAmount

- -

Added In API Version 01.00.00

- -

The frame vertical blur amount of a KimonoStyle.

-
HasFrameShadow

-HasFrameShadow

- -

Added In API Version 01.00.00

- -

The has frame shadow of a KimonoStyle.

-
FrameShadowHorizontalOffset

-FrameShadowHorizontalOffset

- -

Added In API Version 01.00.00

- -

The frame horizontal offset of a KimonoStyle.

-
FrameShadowVerticalOffset

-FrameShadowVerticalOffset

- -

Added In API Version 01.00.00

- -

The frame vertical offset of a KimonoStyle.

-
FrameShadowHorizontalBlurAmount

-FrameShadowHorizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The frame shadow horizontal blur amount of a `KimonoStyle.

-
FrameShadowVerticalBlurAmount

-FrameShadowVerticalBlurAmount

- -

Added In API Version 01.00.00

- -

The frame shadow vertical blur amount of a KimonoStyle.

-
FrameShadowLinkedColor

-FrameShadowLinkedColor

- -

Added In API Version 01.00.00

- -

The color of the frame shadow linked of a KimonoStyle.

-
HasFill

-HasFill

- -

Added In API Version 01.00.00

- -

The has fill of a KimonoStyle.

-
HasFillBlur

-HasFillBlur

- -

Added In API Version 01.00.00

- -

The has fill blur of a KimonoStyle.

-
FillHorizontalBlurAmount

-FillHorizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The fill horizontal blur amount of a KimonoStyle.

-
FillVerticalBlurAmount

-FillVerticalBlurAmount

- -

Added In API Version 01.00.00

- -

The fill vertical blur amount of a KimonoStyle.

-
HasFillShadow

-HasFillShadow

- -

Added In API Version 01.00.00

- -

The has fill shadow of a KimonoStyle.

-
FillShadowHorizontalOffset

-FillShadowHorizontalOffset

- -

Added In API Version 01.00.00

- -

The fill shadow horizontal offset of a KimonoStyle.

-
FillShadowVerticalOffset

-FillShadowVerticalOffset

- -

Added In API Version 01.00.00

- -

The fill shadow vertical offset of a KimonoStyle.

-
FillShadowHorizontalBlurAmount

-FillShadowHorizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The fill shadow horizontal blur amount of a KimonoStyle.

-
FillShadowVerticalBlurAmount

-FillShadowVerticalBlurAmount

- -

Added In API Version 01.00.00

- -

The fill shadow vertical blur amount of a KimonoStyle.

-
FillShadowLinkedColor

-FillShadowLinkedColor

- -

Added In API Version 01.00.00

- -

The color of the fill shadow linked of a KimonoStyle.

-
FrameColor

-FrameColor

- -

Added In API Version 01.00.00

- -

The color of the frame of a KimonoStyle.

-
FrameGradient

-FrameGradient

- -

Added In API Version 01.00.00

- -

The frame gradient of a KimonoStyle.

-
FillColor

-FillColor

- -

Added In API Version 01.00.00

- -

The color of the fill of a KimonoStyle.

-
FillGradient

-FillGradient

- -

Added In API Version 01.00.00

- -

The fill gradient of a KimonoStyle.

-
IsVerticalText

-IsVerticalText

- -

Added In API Version 01.00.00

- -

The is vertical text of a KimonoStyle.

-
StrikeThruText

-StrikeThruText

- -

Added In API Version 01.00.00

- -

The strike thru text of a KimonoStyle.

-
TextScaleX

-TextScaleX

- -

Added In API Version 01.00.00

- -

The text scale x of a KimonoStyle.

-
TextSize

-TextSize

- -

Added In API Version 01.00.00

- -

The size of the text of a KimonoStyle.

-
TextSkewX

-TextSkewX

- -

Added In API Version 01.00.00

- -

The text skew x of a KimonoStyle.

-
FontFamilyName

-FontFamilyName

- -

Added In API Version 01.00.00

- -

The name of the font family of a KimonoStyle.

-
UnderlineText

-UnderlineText

- -

Added In API Version 01.00.00

- -

The underline text of a KimonoStyle.

-
HasFrameJitter

-HasFrameJitter

- -

Added In API Version 01.00.00

- -

The has frame jitter of a KimonoStyle.

-
FrameJitterLength

-FrameJitterLength

- -

Added In API Version 01.00.00

- -

The length of the frame jitter of a KimonoStyle.

-
FrameJitterDeviation

-FrameJitterDeviation

- -

Added In API Version 01.00.00

- -

The frame jitter deviation of a KimonoStyle.

-
HasFillJitter

-HasFillJitter

- -

Added In API Version 01.00.00

- -

The has fill jitter of a KimonoStyle.

-
FillJitterLength

-FillJitterLength

- -

Added In API Version 01.00.00

- -

The length of the fill jitter of a KimonoStyle.

-
FillJitterDeviation

-FillJitterDeviation

- -

Added In API Version 01.00.00

- -

The fill jitter deviation of a KimonoStyle.

-
HasFrameDash

-HasFrameDash

- -

Added In API Version 01.00.00

- -

The has frame dash of a KimonoStyle.

-

- - ---- - - -##KimonoPropertyConnection - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a connection between a given Kimono Object and a `KimonoProperty`. -

PropertiesSummary
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
ConnectionPoint

- -

ConnectionPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the point that a given KimonoProperty is connected to another Kimono Object.

- -

Return Value

- -

The connection point as a KimonoPropertyConnectionPoint.

-
ConnectedProperty

- -

ConnectedProperty

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the connected property.

- -

Return Value

- -

The connected KimonoProperty.

-

- -

MethodsSummary
KimonoPropertyConnection

- -

KimonoPropertyConnection ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyConnection class.

-
KimonoPropertyConnection

- -

KimonoPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyConnection class.

- -

ParameterSummary
connectionPoint

-Connection point.

-
property

-Property.

-

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##ObiScriptResult - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the result of attempting to execute an Obi Script on a `KimonoProperty` -

PropertiesSummary
Successful

- -

Successful

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether the Obi Script ran successfully.

- -

Return Value

- -

true if successful; otherwise, false.

-
ErrorMessage

- -

ErrorMessage

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the error message if the Obi Script execution failed.

- -

Return Value

- -

The error message or "" if the script ran successfully.

-

- -

MethodsSummary
ObiScriptResult

- -

ObiScriptResult ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the ObiScriptResult class.

-
ObiScriptResult

- -

ObiScriptResult (System.Boolean, System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the ObiScriptResult class.

- -

ParameterSummary
isSuccessful

-If set to true is successful.

-
errorMessage

-Error message.

-

-

- - ---- - - -##KimonoBezierPoint - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Holds the control and end point for a `KimonoShapeBezier` that define a quad section of the Bezier. -

PropertiesSummary
ControlPoint

- -

ControlPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the control point.

- -

Return Value

- -

The control point.

-
EndPoint

- -

EndPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the end point.

- -

Return Value

- -

The end point.

-

- -

MethodsSummary
KimonoBezierPoint

- -

KimonoBezierPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBezierPoint class.

-
KimonoBezierPoint

- -

KimonoBezierPoint (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBezierPoint class.

- -

ParameterSummary
controlPoint

-Control point.

-
endPoint

-End point.

-

-
KimonoBezierPoint

- -

KimonoBezierPoint (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBezierPoint class.

- -

ParameterSummary
controlX

-Control x.

-
controlY

-Control y.

-
endX

-End x.

-
endY

-End y.

-

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoBounds - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the outter bounding box for a `KimonoShape` and contains the routines required to draw the bounds and the control handles as the user edits and moves the shape. -

FieldsSummary
Rect

-Rect

- -

Added In API Version 01.00.00

- -

The base SkRect that holds the internal bounds of the shape.

-
PreviousCenter

-PreviousCenter

- -

Added In API Version 01.00.00

- -

Holds the previous center used in scaling operations.

-
PreviousRect

-PreviousRect

- -

Added In API Version 01.00.00

- -

Holds the previous rect used in scaling operations.

-

- -

PropertiesSummary
State

- -

State

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the current edit state of the KimonoShape.

- -

Return Value

- -

The state as a KimonoShapeState.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
Top

- -

Top

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the top.

- -

Return Value

- -

The top coord location.

-
Left

- -

Left

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the left.

- -

Return Value

- -

The left coord location.

-
Bottom

- -

Bottom

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the bottom.

- -

Return Value

- -

The bottom coord location.

-
Right

- -

Right

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the right.

- -

Return Value

- -

The right coord location.

-
Width

- -

Width

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the width.

- -

Return Value

- -

The width of the shape's bounding box.

-
Height

- -

Height

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the height.

- -

Return Value

- -

The height of the shape's bounding box.

-
HorizontalCenter

- -

HorizontalCenter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the horizontal center.

- -

Return Value

- -

The horizontal center.

-
VerticalCenter

- -

VerticalCenter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the vertical center.

- -

Return Value

- -

The vertical center.

-
Center

- -

Center

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the center.

- -

Return Value

- -

The center.

-
RotationDegrees

- -

RotationDegrees

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the rotation degrees.

- -

Return Value

- -

The rotation degrees.

-
TopLeftHandle

- -

TopLeftHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the top left handle.

- -

Return Value

- -

The top left handle.

-
TopHandle

- -

TopHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the top handle.

- -

Return Value

- -

The top handle.

-
TopRightHandle

- -

TopRightHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the top right handle.

- -

Return Value

- -

The top right handle.

-
RightHandle

- -

RightHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the right handle.

- -

Return Value

- -

The right handle.

-
BottomRightHandle

- -

BottomRightHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the bottom right handle.

- -

Return Value

- -

The bottom right handle.

-
BottomHandle

- -

BottomHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the bottom handle.

- -

Return Value

- -

The bottom handle.

-
BottomLeftHandle

- -

BottomLeftHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the bottom left handle.

- -

Return Value

- -

The bottom left handle.

-
LeftHandle

- -

LeftHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the left handle.

- -

Return Value

- -

The left handle.

-
HitOffset

- -

HitOffset

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the hit offset.

- -

Return Value

- -

The hit offset.

-
HitHandle

- -

HitHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the hit handle.

- -

Return Value

- -

The hit handle.

-

- -

MethodsSummary
KimonoBounds

- -

KimonoBounds ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBounds class.

-
KimonoBounds

- -

KimonoBounds (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBounds class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
KimonoBounds

- -

KimonoBounds (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBounds class.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-
state

-State.

-

-
SavePreviousBounds

- -

SavePreviousBounds ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Saves the previous bounds.

-
ValueBetween

- -

ValueBetween (System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Checks to see if the given value is between the two given points.

- -

ParameterSummary
x

-The x coordinate.

-
a

-The alpha component.

-
b

-The blue component.

-

- -

Returns

- -

The Boolean.

-
AddHandles

- -

AddHandles (KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the control handles to the bounds

-
RemoveHandles

- -

RemoveHandles ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the control handles from the bounds.

-
BoundsChanged

- -

BoundsChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates the location of the edit handles when the bounds has been relocated or resized.

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the bounding box and its edit handles into the given canvas

- -

ParameterSummary
canvas

-Canvas.

-

-
Select

- -

Select ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Puts the KimonoShape into the edit mode and creates the edit handles as required.

-
PlaceUnderConstruction

- -

PlaceUnderConstruction (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Places the bounds under construction.

- -

ParameterSummary
needsHandles

-If set to true needs handles.

-

-
StartGrouping

- -

StartGrouping ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Starts the bounds grouping.

-
Unselect

- -

Unselect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Unselects the KimonoShape as the current edit target and removes any edit handles.

-
ChangeBounds

- -

ChangeBounds (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Changes the bounds to match the given values.

- -

ParameterSummary
left

-Left.

-
top

-Top.

-
right

-Right.

-
bottom

-Bottom.

-

-
GrowBounds

- -

GrowBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adjusts the size of the bounds.

- -

ParameterSummary
point

-The new size as a SKPoint.

-

-
MoveBounds

- -

MoveBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the bounds to the given point.

- -

ParameterSummary
point

-The new top, left location as a SKPoint.

-

-
DragBounds

- -

DragBounds (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the bounds.

- -

ParameterSummary
point

-Point.

-

-
PointInBound

- -

PointInBound (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given point is inside of the current bounds

- -

ParameterSummary
point

-Point.

-

- -

Returns

- -

true, if in bounds, false otherwise.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoHandle - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines an edit handle that the user manipulates to edit the bounds of a `KimonoShape` or the control points of a Bezier object. -

FieldsSummary
DrawWidth

-DrawWidth

- -

Added In API Version 01.00.00

- -

The width of the drag handle.

-
DrawOffset

-DrawOffset

- -

Added In API Version 01.00.00

- -

The draw offset of the drag handle.

-

- -

PropertiesSummary
Index

- -

Index

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the index.

- -

Return Value

- -

The index.

-
HandleType

- -

HandleType

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the type of the handle.

- -

Return Value

- -

The type of the handle as a KimonoHandleType.

-
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
State

- -

State

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the edit state of the KimonoHandle.

- -

Return Value

- -

The state as a KimonoShapeState.

-
X

- -

X

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the x value.

- -

Return Value

- -

The x coord of the handle's top-left location.

-
Y

- -

Y

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the y value.

- -

Return Value

- -

The y coord of the handle's top-left location.

-
Rect

- -

Rect

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the rect.

- -

Return Value

- -

The rect.

-
Constraint

- -

Constraint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the edit constraint.

- -

Return Value

- -

The edit constraint as a KimonoHandleConstraint.

-
HitOffset

- -

HitOffset

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the hit offset.

- -

Return Value

- -

The hit offset.

-
Color

- -

Color

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color that this handle represents in a gradient. If the LinkedColor property is null, this color will be used.

- -

Return Value

- -

The SKColor.

-
LinkedColor

- -

LinkedColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color that this handle represents in a gradient. If the LinkedColor property is null, the Color property will be used instead.

- -

Return Value

- -

The color of the linked.

-
RepresentedColor

- -

RepresentedColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the color that this handle represents.

- -

Return Value

- -

The color as a SKColor.

-

- -

MethodsSummary
KimonoHandle

- -

KimonoHandle (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoHandle class.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-

-
KimonoHandle

- -

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoHandle class.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-
state

-State.

-

-
KimonoHandle

- -

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoHandleConstraint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoHandle class.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-
constraint

-Constraint.

-

-
KimonoHandle

- -

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoHandleConstraint, KimonoCore.KimonoShapeState)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoHandle class.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-
constraint

-Constraint.

-
state

-State.

-

-
Draw

- -

Draw (SkiaSharp.SKCanvas)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the hanled into the given Skia canvas.

- -

ParameterSummary
canvas

-The SKCanvas to draw the hanled into.

-

- -

Returns

- -

The draw.

-
MoveTo

- -

MoveTo (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Moves the handle to the given coordinates.

- -

ParameterSummary
x

-The x coordinate.

-
y

-The y coordinate.

-

-
PointInBound

- -

PointInBound (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Test to see if the given point is inside of the current bounds

- -

ParameterSummary
point

-Point.

-

- -

Returns

- -

true, if in bounds, false otherwise.

-
DragHandle

- -

DragHandle (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Drags the handle.

- -

ParameterSummary
point

-Point.

-

-
ToPoint

- -

ToPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoHandle to a Skia Point.

- -

Returns

- -

The SKPoint.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-
RaiseMoved

- -

RaiseMoved (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the moved event.

- -

ParameterSummary
point

-Point.

-

-

- -

EventsSummary
Moved

- -

Moved

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when moved.

-

- - ---- - - -##KimonoHandleConstraint - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Constrains the movement of a `KimonoHandle` when it is being moved by the user. -

FieldsSummary
None

-None

- -

Added In API Version 01.00.00

- -

No movement constraint.

-
Horizontal

-Horizontal

- -

Added In API Version 01.00.00

- -

The handle can only be moved horizontally.

-
Vertical

-Vertical

- -

Added In API Version 01.00.00

- -

The handle can only be moved vertically.

-
Locked

-Locked

- -

Added In API Version 01.00.00

- -

The handle is locked in place and cannot be moved.

-

- - ---- - - -##KimonoHandleType - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the type of a `KimonoHandle` that can be used as a general purpose control point to adjust the bounds of a `KimonoShape` or as a point for a vector or bezier object. -

FieldsSummary
ControlPoint

-ControlPoint

- -

Added In API Version 01.00.00

- -

A general purpose handle for a shape's bound or a control point on a vector or bezier.

-
GradientColor

-GradientColor

- -

Added In API Version 01.00.00

- -

Defines a color inside of a gradient.

-
GradientPosition

-GradientPosition

- -

Added In API Version 01.00.00

- -

Defines the position of a gradient in a shape object.

-
BezierControlPoint

-BezierControlPoint

- -

Added In API Version 01.00.00

- -

Defines the control point for a KimonoShapeBezier end point used to adjust the curve of a bezier quad section.

-

- - ---- - - -##KimonoBlur - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a blur effect that can be attached to the fill or the frame of a `KimonoShape`. -

FieldsSummary
_horizontalBlurAmount

-_horizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The horizontal blur amount.

-
_verticalBlurAmount

-_verticalBlurAmount

- -

Added In API Version 01.00.00

- -

The vertical blur amount.

-

- -

PropertiesSummary
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
HorizontalBlurAmount

- -

HorizontalBlurAmount

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the horizontal blur amount.

- -

Return Value

- -

The horizontal blur amount.

-
VerticalBlurAmount

- -

VerticalBlurAmount

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the vertical blur amount.

- -

Return Value

- -

The vertical blur amount.

-
BlurFilter

- -

BlurFilter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the blur filter represented by this blur effect.

- -

Return Value

- -

The SKImageFilter for the blur filter.

-

- -

MethodsSummary
KimonoBlur

- -

KimonoBlur ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBlur class.

-
KimonoBlur

- -

KimonoBlur (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoBlur class.

- -

ParameterSummary
horizontalBlurAmount

-Horizontal blur amount.

-
verticalBlurAmount

-Vertical blur amount.

-

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this blur effect to code using the Skia library.

- -

Returns

- -

The blur as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this blur effect to code using the KimonoCore library.

- -

Returns

- -

The blur as code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-
RaiseBlurModified

- -

RaiseBlurModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the blur modified event.

-

- -

EventsSummary
BlurModified

- -

BlurModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when the blur is modified.

-

- - ---- - - -##KimonoShadow - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a shadow effect that can be attached to the fill or the frame of a `KimonoShape`. -

FieldsSummary
_horizontalOffset

-_horizontalOffset

- -

Added In API Version 01.00.00

- -

The horizontal offset.

-
_verticalOffset

-_verticalOffset

- -

Added In API Version 01.00.00

- -

The vertical offset.

-
_horizontalBlurAmount

-_horizontalBlurAmount

- -

Added In API Version 01.00.00

- -

The horizontal blur amount.

-
_verticalBlurAmount

-_verticalBlurAmount

- -

Added In API Version 01.00.00

- -

The vertical blur amount.

-
_color

-_color

- -

Added In API Version 01.00.00

- -

The color of the shadow.

-
_linkedColor

-_linkedColor

- -

Added In API Version 01.00.00

- -

A linked KimonoColor to use as the shadow color.

-

- -

PropertiesSummary
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
HorizontalOffset

- -

HorizontalOffset

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the horizontal offset.

- -

Return Value

- -

The horizontal offset.

-
VerticalOffset

- -

VerticalOffset

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the vertical offset.

- -

Return Value

- -

The vertical offset.

-
HorizontalBlurAmount

- -

HorizontalBlurAmount

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the horizontal blur amount.

- -

Return Value

- -

The horizontal blur amount.

-
VerticalBlurAmount

- -

VerticalBlurAmount

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the vertical blur amount.

- -

Return Value

- -

The vertical blur amount.

-
Color

- -

Color

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color of the shadow.

- -

Return Value

- -

The color.

-
LinkedColor

- -

LinkedColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color of the linked.

- -

Return Value

- -

The color of the linked.

-
ShadowColor

- -

ShadowColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the color of the shadow.

- -

Return Value

- -

The color of the shadow as a SKColor.

- -

Remarks

- -

Returns either the custom color attached to this shadow or a linked color if it is being used.

-
ShadowFilter

- -

ShadowFilter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the shadoe filter represented by this shadow effect.

- -

Return Value

- -

The SKImageFilter for the blur filter.

-

- -

MethodsSummary
KimonoShadow

- -

KimonoShadow ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShadow class.

-
KimonoShadow

- -

KimonoShadow (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoShadow class.

- -

ParameterSummary
horizontalOffset

-Horizontal offset.

-
horizontalBlurAmount

-Horizontal blur amount.

-
verticalOffset

-Vertical offset.

-
verticalBlurAmount

-Vertical blur amount.

-

-
HandleLinkedColorChanged

- -

HandleLinkedColorChanged ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the linked color changed.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shadow to C# code using the Skia library.

- -

Returns

- -

The shadow as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shadow to C# code using the KimonoCore library.

- -

Returns

- -

The shadow as code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-
RaiseShadowModified

- -

RaiseShadowModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the shadow modified event.

-

- -

EventsSummary
ShadowModified

- -

ShadowModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when the shadow is modified.

-

- - ---- - - -##KimonoGradient - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a gradient as a collection of either `SKColor` or linked `KimonoColors` that can be applied to a `KimonoStyle` and used when drawing a `KimonoShape`. -

FieldsSummary
_gradientType

-_gradientType

- -

Added In API Version 01.00.00

- -

The type of the gradient.

-
_startPoint

-_startPoint

- -

Added In API Version 01.00.00

- -

The start point.

-
_endPoint

-_endPoint

- -

Added In API Version 01.00.00

- -

The end point.

-
_radius

-_radius

- -

Added In API Version 01.00.00

- -

The radius for radial and conical gradients.

-
_tileMode

-_tileMode

- -

Added In API Version 01.00.00

- -

The gradient tile mode.

-
_selectedHandle

-_selectedHandle

- -

Added In API Version 01.00.00

- -

The selected handle.

-
PerformingDrag

-PerformingDrag

- -

Added In API Version 01.00.00

- -

Is the user performing a drag operation.

-

- -

PropertiesSummary
GradientType

- -

GradientType

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the type of the gradient.

- -

Return Value

- -

The type of the gradient.

-
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
ElementName

- -

ElementName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the element as it will be called in generated source code.

- -

Return Value

- -

The name of the element.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
BarWidth

- -

BarWidth

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the width of the bar.

- -

Return Value

- -

The width of the bar.

-
BarHeight

- -

BarHeight

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the height of the bar.

- -

Return Value

- -

The height of the bar.

-
PreviewWidth

- -

PreviewWidth

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the width of the preview.

- -

Return Value

- -

The width of the preview.

-
PreviewHeight

- -

PreviewHeight

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the height of the preview.

- -

Return Value

- -

The height of the preview.

-
StartPoint

- -

StartPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the start point.

- -

Return Value

- -

The start point.

-
EndPoint

- -

EndPoint

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the end point.

- -

Return Value

- -

The end point.

-
Radius

- -

Radius

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the radius used by radial and conical gradients.

- -

Return Value

- -

The radius.

-
TileMode

- -

TileMode

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the tile mode.

- -

Return Value

- -

The tile mode.

-
ControlPoints

- -

ControlPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the control points that define the color.

- -

Return Value

- -

The control points.

-
SelectedHandle

- -

SelectedHandle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the selected handle.

- -

Return Value

- -

The selected handle.

-
SelectedColor

- -

SelectedColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the color of the selected handle.

- -

Return Value

- -

The color of the selected handle or black if no handle is selected.

-
Shader

- -

Shader

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the Skia Shader that represents this gradient.

- -

Return Value

- -

The SKShader for this gradient.

-

- -

MethodsSummary
KimonoGradient

- -

KimonoGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoGradient class.

-
KimonoGradient

- -

KimonoGradient (KimonoCore.KimonoGradientType, KimonoCore.KimonoHandle, KimonoCore.KimonoHandle, System.Single, SkiaSharp.SKShaderTileMode, SkiaSharp.SKColor[], System.Single[])

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoGradient class.

- -

ParameterSummary
gradientType

-Gradient type.

-
startPoint

-Start point.

-
endPoint

-End point.

-
radius

-Radius.

-
tileMode

-Tile mode.

-
colors

-Colors.

-
weights

-Weights.

-

-
KimonoGradient

- -

KimonoGradient (System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoGradient class.

- -

ParameterSummary
barWidth

-Bar width.

-
barHeight

-Bar height.

-

-
KimonoGradient

- -

KimonoGradient (System.Single, System.Single, System.Single, System.Single)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoGradient class.

- -

ParameterSummary
barWidth

-Bar width.

-
barHeight

-Bar height.

-
previewWidth

-Preview width.

-
previewHeight

-Preview height.

-

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
SortedColors

- -

SortedColors ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns a list of sorted colors by their "X" location inside the gradient.

- -

Returns

- -

The sorted colors arrays.

-
SortedWeights

- -

SortedWeights ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns a list a color weights by their "X" location in the gradient.

- -

Returns

- -

The sorted weights.

-
ConformingShader

- -

ConformingShader (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Generates a shader that conforms to a given start and end point.

- -

ParameterSummary
startPoint

-Start point.

-
endPoint

-End point.

-

- -

Returns

- -

The SKShader for the gradient bound to a given shape's dimentions.

-
AddControlPoint

- -

AddControlPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds a new control point to the gradients collection and makes it the selected control point.

-
DeleteSelectedControlPoint

- -

DeleteSelectedControlPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Deletes the selected control point.

-
DuplicateSelectedControlPoint

- -

DuplicateSelectedControlPoint ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Duplicates the selected control point.

-
FindHandle

- -

FindHandle (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Finds the handle matching the given unique ID.

- -

ParameterSummary
uniqueID

-Unique identifier.

-

- -

Returns

- -

The matching KimonoHandle or null if not found.

-
DrawBar

- -

DrawBar ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the bar.

- -

Returns

- -

The bar.

-
DrawPreview

- -

DrawPreview ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Draws the preview.

- -

Returns

- -

The preview.

-
BarToolDown

- -

BarToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user clicking a control point in the gradient design bar.

- -

ParameterSummary
point

-The point the user clicked.

-
clicks

-The number of times the user clicked.

-
multiSelect

-If set to true multi select.

-

-
BarToolDrag

- -

BarToolDrag (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user draging a control point in the gradient design bar.

- -

ParameterSummary
point

-The new location.

-

-
BarToolUp

- -

BarToolUp (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user releasing a control point in the gradient design bar.

- -

ParameterSummary
point

-Point.

-

-
PreviewToolDown

- -

PreviewToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user clicking a control point in the gradient preview.

- -

ParameterSummary
point

-The point the user clicked.

-
clicks

-The number of times the user clicked.

-
multiSelect

-If set to true multi select.

-

-
PreviewToolDrag

- -

PreviewToolDrag (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user draging a control point in the gradient preview.

- -

ParameterSummary
point

-The new location.

-

-
PreviewToolUp

- -

PreviewToolUp (SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the user releasing a control point in the gradient preview.

- -

ParameterSummary
point

-Point.

-

-
ToObiScript

- -

ToObiScript ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to Obi Script represnetation.

- -

Returns

- -

The obi script.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ColorsToCode

- -

ColorsToCode (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this graidents colors to Skia code.

- -

Returns

- -

The color list as code.

-
ColorsToInitializer

- -

ColorsToInitializer (KimonoCore.CodeOutputLibrary, System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this graidents colors to Skia code.

- -

Returns

- -

The color list as code.

-
WeightsToSkiaCode

- -

WeightsToSkiaCode ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this gradients weights to Skia Code.

- -

Returns

- -

The weight list as code.

-
WeightsToSkiaInitializer

- -

WeightsToSkiaInitializer (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this gradients weights to Skia Code.

- -

Returns

- -

The weight list as code.

-
ToCSharpSkia

- -

ToCSharpSkia ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the gradient to C# Skia csource code.

- -

Returns

- -

The gradient as code.

-
ToCSharpSkiaInitializer

- -

ToCSharpSkiaInitializer ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the gradient to C# Skia csource code.

- -

Returns

- -

The gradient as code.

-
ToCSharpSkia

- -

ToCSharpSkia (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the gradient to C# Skia csource code.

- -

ParameterSummary
startPoint

-The starting SKPoint.

-
endPoint

-The ending SKPoint.

-

- -

Returns

- -

The gradient as code.

-
ToCSharpKimonoCore

- -

ToCSharpKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this gradient to code using the KimonoCore library.

- -

Returns

- -

The gradient as code.

-
ToCSharpKimonoCoreInitializer

- -

ToCSharpKimonoCoreInitializer ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this gradient to code using the KimonoCore library.

- -

Returns

- -

The gradient as code.

-
ToCSharpKimonoCore

- -

ToCSharpKimonoCore (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this gradient to code using the KimonoCore library.

- -

ParameterSummary
startPoint

-The starting SKPoint.

-
endPoint

-The ending SKPoint.

-

- -

Returns

- -

The gradient as code.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the object to C# source code for the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The C# source code.

-
ToCSharpInitializer

- -

ToCSharpInitializer (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the object to C# source code for the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The C# source code.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary, SkiaSharp.SKPoint, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the object to C# source code for the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-
startPoint

-The starting SKPoint.

-
endPoint

-The ending SKPoint.

-

- -

Returns

- -

The C# source code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-
RaiseGradientModified

- -

RaiseGradientModified ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the gradient modified event.

-
RaiseHandleSelected

- -

RaiseHandleSelected (KimonoCore.KimonoHandle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Raises the handle selected event.

- -

ParameterSummary
handle

-Handle.

-

-

- -

EventsSummary
GradientModified

- -

GradientModified

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when the gradient is modified.

-
HandleSelected

- -

HandleSelected

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Occurs when a handle is selected.

-

- - ---- - - -##KimonoGradientType - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Kimono gradient type. -

FieldsSummary
LinearGradient

-LinearGradient

- -

Added In API Version 01.00.00

- -

The linear gradient.

-
RadialGradient

-RadialGradient

- -

Added In API Version 01.00.00

- -

The radial gradient.

-
SweepGradient

-SweepGradient

- -

Added In API Version 01.00.00

- -

The sweep gradient.

-
ConicalGradient

-ConicalGradient

- -

Added In API Version 01.00.00

- -

The conical gradient.

-

- - ---- - - -##KimonoStyle - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines as style that can be applied to a `KimonoShape` to control its appearance. -

FieldsSummary
_frameColor

-_frameColor

- -

Added In API Version 01.00.00

- -

Holds a named KimonoColor attached to the style's frame color.

-
_fillColor

-_fillColor

- -

Added In API Version 01.00.00

- -

Holds a named KimonoColor attached to the style's fill color.

-
_frameGradient

-_frameGradient

- -

Added In API Version 01.00.00

- -

The frame gradient.

-
_fillGradient

-_fillGradient

- -

Added In API Version 01.00.00

- -

The fill gradient.

-
_hasFrameJitter

-_hasFrameJitter

- -

Added In API Version 01.00.00

- -

If true, the frame uses the jitter effect.

-
_frameJitterLength

-_frameJitterLength

- -

Added In API Version 01.00.00

- -

The length of the frame jitter.

-
_frameJitterDeviation

-_frameJitterDeviation

- -

Added In API Version 01.00.00

- -

The frame jitter deviation.

-
_hasFillJitter

-_hasFillJitter

- -

Added In API Version 01.00.00

- -

If true, the fill uses the jitter effect.

-
_fillJitterLength

-_fillJitterLength

- -

Added In API Version 01.00.00

- -

The length of the fill jitter.

-
_fillJitterDeviation

-_fillJitterDeviation

- -

Added In API Version 01.00.00

- -

The fill jitter deviation.

-
_hasFrameDash

-_hasFrameDash

- -

Added In API Version 01.00.00

- -

If true, the frame has a dash effect.

-
_hasFillBlur

-_hasFillBlur

- -

Added In API Version 01.00.00

- -

The has fill blur.

-
_fillBlur

-_fillBlur

- -

Added In API Version 01.00.00

- -

The fill blur.

-
_hasFrameBlur

-_hasFrameBlur

- -

Added In API Version 01.00.00

- -

The has frame blur.

-
_frameBlur

-_frameBlur

- -

Added In API Version 01.00.00

- -

The frame blur.

-
_hasFillShadow

-_hasFillShadow

- -

Added In API Version 01.00.00

- -

The has fill shadow.

-
_fillShadow

-_fillShadow

- -

Added In API Version 01.00.00

- -

The fill shadow.

-
_hasFrameShadow

-_hasFrameShadow

- -

Added In API Version 01.00.00

- -

The has frame shadow.

-
_frameShadow

-_frameShadow

- -

Added In API Version 01.00.00

- -

The frame shadow.

-

- -

PropertiesSummary
UniqueID

- -

UniqueID

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the unique identifier.

- -

Return Value

- -

The unique identifier.

-
ElementName

- -

ElementName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the element as it will be called in generated source code.

- -

Return Value

- -

The name of the element.

-
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name.

- -

Return Value

- -

The name.

-
HasFrame

- -

HasFrame

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has a frame.

- -

Return Value

- -

true if has frame; otherwise, false.

-
Frame

- -

Frame

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the frame paint style.

- -

Return Value

- -

The SKPaint style for the frame.

-
HasFrameBlur

- -

HasFrameBlur

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has frame blur.

- -

Return Value

- -

true if has frame blur; otherwise, false.

-
FrameBlur

- -

FrameBlur

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the frame blur.

- -

Return Value

- -

The KimonoBlur applied to the frame.

-
HasFrameShadow

- -

HasFrameShadow

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has frame shadow.

- -

Return Value

- -

true if has frame shadow; otherwise, false.

-
FrameShadow

- -

FrameShadow

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the frame shadow.

- -

Return Value

- -

The frame shadow as a KimonoShadow.

-
HasFillBlur

- -

HasFillBlur

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has fill blur.

- -

Return Value

- -

true if has fill blur; otherwise, false.

-
FillBlur

- -

FillBlur

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the fill blur.

- -

Return Value

- -

The KimonoBlur applied to the fill.

-
HasFillShadow

- -

HasFillShadow

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has fill shadow.

- -

Return Value

- -

true if has fill shadow; otherwise, false.

-
FillShadow

- -

FillShadow

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the fill shadow.

- -

Return Value

- -

The fill shadow.

-
FrameColor

- -

FrameColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color of the frame as a named Kimono Color.

- -

Return Value

- -

The color of the frame.

-
FrameGradient

- -

FrameGradient

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the frame gradient.

- -

Return Value

- -

The frame gradient.

-
HasFill

- -

HasFill

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle has fill.

- -

Return Value

- -

true if has fill; otherwise, false.

-
Fill

- -

Fill

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the fill paint style.

- -

Return Value

- -

The SKPaint style for the fill.

-
FillColor

- -

FillColor

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the color of the fill as a named Kimono Color.

- -

Return Value

- -

The color of the fill.

-
FillGradient

- -

FillGradient

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the fill gradient.

- -

Return Value

- -

The fill gradient.

-
StyleType

- -

StyleType

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the type of the style.

- -

Return Value

- -

The type of the style.

-
FontMetrics

- -

FontMetrics

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the font metrics.

- -

Return Value

- -

The font metrics.

-
IsLinearText

- -

IsLinearText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle is linear text.

- -

Return Value

- -

true if is linear text; otherwise, false.

-
IsVerticalText

- -

IsVerticalText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle is vertical text.

- -

Return Value

- -

true if is vertical text; otherwise, false.

-
StrikeThruText

- -

StrikeThruText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle strike thru text.

- -

Return Value

- -

true if strike thru text; otherwise, false.

-
TextAlign

- -

TextAlign

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text align.

- -

Return Value

- -

The text align.

-
TextEncoding

- -

TextEncoding

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text encoding.

- -

Return Value

- -

The text encoding.

-
TextScaleX

- -

TextScaleX

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text scale x.

- -

Return Value

- -

The text scale x.

-
TextSize

- -

TextSize

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the size of the text.

- -

Return Value

- -

The size of the text.

-
TextSkewX

- -

TextSkewX

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the text skew x.

- -

Return Value

- -

The text skew x.

-
Typeface

- -

Typeface

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the typeface.

- -

Return Value

- -

The typeface.

-
FontFamilyName

- -

FontFamilyName

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the name of the font family.

- -

Return Value

- -

The name of the font family.

-
TypefaceStyle

- -

TypefaceStyle

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the typeface style.

- -

Return Value

- -

The typeface style.

-
UnderlineText

- -

UnderlineText

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether this KimonoStyle underline text.

- -

Return Value

- -

true if underline text; otherwise, false.

-
HasFrameJitter

- -

HasFrameJitter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether the frame jitter is used.

- -

Return Value

- -

true if has frame jitter; otherwise, false.

-
FrameJitterLength

- -

FrameJitterLength

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the length of the frame jitter.

- -

Return Value

- -

The length of the frame jitter.

-
FrameJitterDeviation

- -

FrameJitterDeviation

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the frame jitter deviation.

- -

Return Value

- -

The frame jitter deviation.

-
HasFillJitter

- -

HasFillJitter

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether the fill jitter is used.

- -

Return Value

- -

true if has fill jitter; otherwise, false.

-
FillJitterLength

- -

FillJitterLength

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the length of the fill jitter.

- -

Return Value

- -

The length of the fill jitter.

-
FillJitterDeviation

- -

FillJitterDeviation

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the fill jitter deviation.

- -

Return Value

- -

The fill jitter deviation.

-
HasFrameDash

- -

HasFrameDash

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets a value indicating whether the frame has a dash.

- -

Return Value

- -

true if the frame has a dash; otherwise, false.

-
DashPattern

- -

DashPattern

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the dash pattern.

- -

Return Value

- -

The dash pattern.

-
ConnectionPoints

- -

ConnectionPoints

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the possible connection points that a KimonoProperty can be connected to this KimonoStyle.

- -

Return Value

- -

The array of KimonoPropertyConnectionPoint.

-
PropertyConnections

- -

PropertyConnections

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the list of KimonoProperty objects connected to the various KimonoPropertyConnectionPoints that will need to be evaulated before drawing this KimonoShape.

- -

Return Value

- -

The property connections.

-

- -

MethodsSummary
ClonePaint

- -

ClonePaint (SkiaSharp.SKPaint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clones the given SKPaint object.

- -

ParameterSummary
paint

-The SKPaint object to clone.

-

- -

Returns

- -

The new SKPaint instance.

-
KimonoStyle

- -

KimonoStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoStyle class.

-
Initialize

- -

Initialize ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initialize this instance.

-
HandleFrameBlurOrShadowChange

- -

HandleFrameBlurOrShadowChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the frame blur change.

-
HandleFillBlurOrShadowChange

- -

HandleFillBlurOrShadowChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the fill blur change.

-
HandleFrameColorChange

- -

HandleFrameColorChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the frame color change.

-
HandleFillColorChange

- -

HandleFillColorChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the fill color change.

-
HandleFrameGradientChange

- -

HandleFrameGradientChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the frame gradient change.

-
HandleFillGradientChange

- -

HandleFillGradientChange ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Handles the fill gradient change.

-
MakeDashInterval

- -

MakeDashInterval ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Makes the dash interval from the dash pattern.

- -

Returns

- -

The dash interval.

-
AddPropertyConnection

- -

AddPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Connects the given KimonoProperty to the given KimonoPropertyConnectionPoint on this KimonoStyle.

- -

ParameterSummary
connectionPoint

-The KimonoPropertyConnectionPoint to connect to.

-
property

-The KimonoProperty to connect.

-

-
RemovePropertyConnection

- -

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes the property connection.

- -

ParameterSummary
connection

-The KimonoPropertyConnection to remove.

-

-
RemoveProperty

- -

RemoveProperty (KimonoCore.KimonoProperty)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Removes any connection using this property.

- -

ParameterSummary
property

-The KimonoProperty to remove.

-

-
EvaluateConnectedProperties

- -

EvaluateConnectedProperties ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluates all of the KimonoProperty objects attached to this KimonoStyle by executling their Obi Scripts and updating the values with the results.

-
UpdatePropertyConnectionPoint

- -

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Updates a KimonoPropertyConnectionPoint on this KimonoStyle with the results of a Obi Script run on an attached KimonoProperty.

- -

ParameterSummary
connection

-Connection.

-

-
ApplyFrameEffects

- -

ApplyFrameEffects ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the frame effects based on the style settings.

-
ApplyFillEffects

- -

ApplyFillEffects ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Applies the fill effects based on the style settings.

-
ToObiScript

- -

ToObiScript ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to Obi Script represnetation.

- -

Returns

- -

The obi script.

-
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
FillToSkiaCode

- -

FillToSkiaCode ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style's Fill to C# code using the Skia library.

- -

Returns

- -

The Fill SKPaint as code.

-
FillToSkiaInitializer

- -

FillToSkiaInitializer (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style's Fill to C# code using the Skia library.

- -

Returns

- -

The Fill SKPaint as code.

-
FrameToSkiaCode

- -

FrameToSkiaCode ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style's Frame to C# code using the Skia library.

- -

Returns

- -

The Frame SKPaint as code.

-
FrameToSkiaInitializer

- -

FrameToSkiaInitializer (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style's Frame to C# code using the Skia library.

- -

Returns

- -

The Frame SKPaint as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style to C# code using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToKimonoCoreInitializer

- -

ToKimonoCoreInitializer (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this style to C# code using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this styl to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to generate code in.

-

- -

Returns

- -

The style as code.

-
ToCSharpInitializer

- -

ToCSharpInitializer (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this styl to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to generate code in.

-

- -

Returns

- -

The style as code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-
Clone

- -

Clone (System.Boolean)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clones the KimonoStyle.

- -

ParameterSummary
deepClone

-If set to true, a deep clone of the style is made.

-

- -

Returns

- -

The a clone of the KimonoStyle.

-

- - ---- - - -##KimonoStyleType - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the type of a `KimonoStyle` that will be used to draw a given `KimonoShape` in. -

FieldsSummary
Default

-Default

- -

Added In API Version 01.00.00

- -

The default style for new shapes. This style cannot be deleted or renamed by the user.

-
Custom

-Custom

- -

Added In API Version 01.00.00

- -

A custom style that belongs only to an individual shape instance.

-
CustomText

-CustomText

- -

Added In API Version 01.00.00

- -

A custom text style that belongs only to an individual KimonoShapeText instance.

-
Standard

-Standard

- -

Added In API Version 01.00.00

- -

A shared style that can be applied to multiple Kimonoshape instances.

-
Text

-Text

- -

Added In API Version 01.00.00

- -

A shared text style that can be applied to multiple KimonoShapeText instances.

-

- - ---- - - -##KimonoPropertyRect - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `SKRect`. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The value as a SKRect.

-

- -

MethodsSummary
KimonoPropertyRect

- -

KimonoPropertyRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyRect class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToRect

- -

ToRect ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a SKRect.

- -

Returns

- -

The SKRect value.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyNumber - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `float` or `int` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The float value.

-

- -

MethodsSummary
KimonoPropertyNumber

- -

KimonoPropertyNumber ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyNumber class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToFloat

- -

ToFloat ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a float.

- -

Returns

- -

The float value.

-
ToInt

- -

ToInt ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to an int.

- -

Returns

- -

The int value.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyStyle - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `KimonoStyle` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The KimonoStyle value.

-
IsObiScriptValue

- -

IsObiScriptValue

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoPropertyColor is obi script value.

- -

Return Value

- -

true if is obi script value; otherwise, false.

-

- -

MethodsSummary
KimonoPropertyStyle

- -

KimonoPropertyStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyStyle class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToStyle

- -

ToStyle ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoStyle.

- -

Returns

- -

The KimonoStyle value.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyBoolean - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `bool` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The bool value.

-

- -

MethodsSummary
KimonoPropertyBoolean

- -

KimonoPropertyBoolean ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyBoolean class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToBool

- -

ToBool ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a bool.

- -

Returns

- -

true, if bool was toed, false otherwise.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyText - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `string` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The value.

-

- -

MethodsSummary
KimonoPropertyText

- -

KimonoPropertyText ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyText class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToString

- -

ToString ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a string.

- -

Returns

- -

The string value.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyColor - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `KimonoColor` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The KimonoColor value.

-
IsObiScriptValue

- -

IsObiScriptValue

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoPropertyColor is obi script value.

- -

Return Value

- -

true if is obi script value; otherwise, false.

-

- -

MethodsSummary
KimonoPropertyColor

- -

KimonoPropertyColor ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyText class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToColor

- -

ToColor ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoColor.

- -

Returns

- -

The color.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##KimonoPropertyGradient - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines a `KimonoProperty` that represents a `KimonoGradient` value. -

PropertiesSummary
Value

- -

Value

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets or sets the value.

- -

Return Value

- -

The KimonoGradient value.

-
IsObiScriptValue

- -

IsObiScriptValue

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets a value indicating whether this KimonoPropertyColor is obi script value.

- -

Return Value

- -

true if is obi script value; otherwise, false.

-

- -

MethodsSummary
KimonoPropertyGradient

- -

KimonoPropertyGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Initializes a new instance of the KimonoPropertyText class.

-
Evaluate

- -

Evaluate ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

- -

Returns

- -

The result of the Obi Script execution as a ObiScriptResult.

-
ToGradient

- -

ToGradient ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this KimonoProperty to a KimonoGradient.

- -

Returns

- -

The gradient.

-
Clone

- -

Clone ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Clone this instance.

- -

Returns

- -

The clone.

-

- - ---- - - -##CodeOutputOS - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the OS that code will be generated for -

FieldsSummary
Windows

-Windows

- -

Added In API Version 01.00.00

- -

For Windows OS based machines.

-
WindowsUWP

-WindowsUWP

- -

Added In API Version 01.00.00

- -

For Windows OS based machines using Universal Windows Platform.

-
WindowsWPF

-WindowsWPF

- -

Added In API Version 01.00.00

- -

For Windows OS based machines using Windows Presentation Foundation.

-
Android

-Android

- -

Added In API Version 01.00.00

- -

For Android OS based machines.

-
iOS

-iOS

- -

Added In API Version 01.00.00

- -

For iOS based machines.

-
tvOS

-tvOS

- -

Added In API Version 01.00.00

- -

For tvOS based machines.

-
macOS

-macOS

- -

Added In API Version 01.00.00

- -

For macOS based machines.

-
CrossPlatform

-CrossPlatform

- -

Added In API Version 01.00.00

- -

Cross-platform code.

-

- - ---- - - -##CodeOutputLanguage - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Defines the language that code will be output in. -

FieldsSummary
CSharp

-CSharp

- -

Added In API Version 01.00.00

- -

Generate code for C#.

-
ObiScript

-ObiScript

- -

Added In API Version 01.00.00

- -

Generate code for the internal ObiScript scripting language.

-

- - ---- - - -##CodeOutputLibrary - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Code output library. -

FieldsSummary
SkiaSharp

-SkiaSharp

- -

Added In API Version 01.00.00

- -

Output pure SkiaSharp code.

-
KimonoCore

-KimonoCore

- -

Added In API Version 01.00.00

- -

Output code using the helper KimonoCore classes.

-

- - ---- - - -##KimonoCodeGenerator - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -The Kimono Code Generator has routine to assist in the generation of output source code. -

FieldsSummary
NextElementNumber

-NextElementNumber

- -

Added In API Version 01.00.00

- -

The next element number.

-
AddNumberToElementNames

-AddNumberToElementNames

- -

Added In API Version 01.00.00

- -

Add number to element names when generating.

-
SupportingColors

-SupportingColors

- -

Added In API Version 01.00.00

- -

A list of supporting colors that are required for the object being converted to source code.

-
SupportingGradients

-SupportingGradients

- -

Added In API Version 01.00.00

- -

A list of supporting gradients that are required for the object being converted to source code.

-
SupportingStyles

-SupportingStyles

- -

Added In API Version 01.00.00

- -

A list of supporting styles that are required for the object being converted to source code.

-

- -

MethodsSummary
ResetCodeGeneration

- -

ResetCodeGeneration ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Resets the code generation.

-
AddSupportingColor

- -

AddSupportingColor (KimonoCore.KimonoColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given color to the collection of named colors that are used in the generation of other Kimono Objects. If a color is already in the collection, its ElementName is returned.

- -

ParameterSummary
color

-The KimonoColor to add to the collection.

-

- -

Returns

- -

The ElementName for the supporting color.

-
CodeForSupportingColors

- -

CodeForSupportingColors (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting colors used in generating a higher level Kimono object.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoColors.

-
PropertyForSupportingColors

- -

PropertyForSupportingColors (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoColors.

-
AddSupportingGradient

- -

AddSupportingGradient (KimonoCore.KimonoGradient)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given gradient to the collection of named gradients that are used in the generation of other Kimono Objects. If a gradient is already in the collection, its ElementName is returned.

- -

ParameterSummary
gradient

-The KimonoGradient to add.

-

- -

Returns

- -

The ElementName for the supporting gradient.

-
CodeForSupportGradients

- -

CodeForSupportGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting gradients used in generating a higher level Kimono object.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoGradients.

-
PrivateVariablesForSupportingGradients

- -

PrivateVariablesForSupportingGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoColors.

-
PropertyForSupportingGradients

- -

PropertyForSupportingGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoColors.

-
InitializerForSupportGradients

- -

InitializerForSupportGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting gradients used in generating a higher level Kimono object.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoGradients.

-
AddSupportingStyle

- -

AddSupportingStyle (KimonoCore.KimonoStyle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Adds the given style to the collection of named styles that are used in the generation of other Kimono Objects. If a style is already in the collection, its ElementName is returned.

- -

ParameterSummary
style

-The KimonoStyle to add.

-

- -

Returns

- -

The ElementName for the supporting style.

-
CodeForSupportStyles

- -

CodeForSupportStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting styles used in generating a higher level Kimono object.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoGradients.

-
PropertyForSupportingStyles

- -

PropertyForSupportingStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoColors.

-
InitializerForSupportStyles

- -

InitializerForSupportStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Returns the source code for all of the supporting styles used in generating a higher level Kimono object.

- -

ParameterSummary
outputLanguage

-The CodeOutputLanguage for the generated code.

-
outputLibrary

-The CodeOutputLibrary of the generated code.

-

- -

Returns

- -

The source code for the supporting KimonoGradients.

-
MakeElementName

- -

MakeElementName (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Makes a valid source code name for the name of a given Kimono Object.

- -

ParameterSummary
name

-The source Kimono Object name.

-

- -

Returns

- -

The element name valid for use in source code.

-
IncreaseIndentLevel

- -

IncreaseIndentLevel (System.String, System.Int32)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Increases the indent level of the given section of source code by the given number of levels

- -

ParameterSummary
sourceCode

-Source code.

-
levels

-Levels.

-

- -

Returns

- -

The indent level.

-
IncreaseIndentLevel

- -

IncreaseIndentLevel (System.String)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Increases the indent level of the given section of source code.

- -

ParameterSummary
sourceCode

-The source code to indent.

-

- -

Returns

- -

The source code indented by one tab.

-
ColorToCode

- -

ColorToCode (KimonoCore.CodeOutputLibrary, SkiaSharp.SKColor)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the given color to code using the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to encode to.

-
color

-The SKColor to create code for.

-

- -

Returns

- -

The color as code.

-
PointToCode

- -

PointToCode (KimonoCore.CodeOutputLibrary, SkiaSharp.SKPoint)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the given point to code using the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to encode to.

-
point

-The SKPoint to encode.

-

- -

Returns

- -

The point as code.

-
PointToCode

- -

PointToCode (KimonoCore.CodeOutputLibrary, KimonoCore.KimonoHandle)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the given point to code using the given library.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to encode to.

-
point

-The KimonoHandle to encode.

-

- -

Returns

- -

The point as code.

-

- - ---- - - -##IKimonoCodeGeneration - -###Namespace - -[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) - -###Added In API Version - -01.00.00 - -###Summary - -Interface for any Kimono Object that support source code generation. -

PropertiesSummary
Name

- -

Name

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Gets the name.

- -

Return Value

- -

The name of the element.

-

- -

MethodsSummary
ToSkiaSharpPath

- -

ToSkiaSharpPath ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shapes path to C# Skia based code.

- -

Returns

- -

The path as code.

-
ToSkiaSharp

- -

ToSkiaSharp ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts the shape to C# code using the Skia library.

- -

Returns

- -

The shape as code.

-
ToKimonoCore

- -

ToKimonoCore ()

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape C# using the KimonoCore library.

- -

Returns

- -

The kimono core.

-
ToCSharp

- -

ToCSharp (KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this shape to C# code.

- -

ParameterSummary
outputLibrary

-The CodeOutputLibrary to use.

-

- -

Returns

- -

The shape as C# code.

-
ToCode

- -

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

- -

Added In API Version

- -

01.00.00

- -

Summary

- -

Converts this object to source code for the given OS, Language and Library.

- -

ParameterSummary
outputOS

-The CodeOutputOS.

-
outputLanguage

-The CodeOutputLanguage.

-
outputLibrary

-The CodeOutputLibrary.

-

- -

Returns

- -

The object represented as source code in a string.

-

- +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + + +# Namespaces + + +--- + + +## KimonoCore + +

TypeSummary
KimonoSketch

Holds a collection of KimonoShapes that are used to create a given image using Skia.

+
KimonoTool

Defines the current tool that is active in a KimonoSketch that the user can use to create or modify a KimonoShape.

+
Kimono

Holds a set of shared utilities that are used across the Kimono classes.

+
KimonoPortfolio

A Kimono Portfolio holds a collection of KimonoSketches, KimonoStyles and KimonoColors that define a given Kimono Designer project.

+
KimonoUndoHandler

Handles the undo/redo state for a KimonoDesignSurface.

+
KimonoShape

Defines the based shape that all other Kimono Shape types will inherit from.

+
KimonoShapeArrow

Draws either an outlined or single line arrow with heads on one or both ends.

+
KimonoShapeBezier

A Kimono Bezier is a collection of control and end points that define the quad sections of a bezier shape to be drawn using SkiaSharp.

+
KimonoShapeGroup

A KimonoShapeGroup holds a collection of KimonoShapes that can be acted upon as a group.

+
KimonoShapeGroupType

Defines the type of a KimonoShapeGroup.

+
KimonoShapeLine

Draws a line on the design surface.

+
KimonoShapeOval

Draws an oval into the Design Surface.

+
KimonoShapePolygon

Draws a multi-sided polygon into the Design Surface.

+
KimonoShapeRect

Draws a rectangle into the Design Surface.

+
KimonoShapeRoundRect

Draws a rounded rectangle into the Design Surface.

+
KimonoShapeStar

Draws a multi-sided star shape into the Design Surface.

+
KimonoShapeState

Holds the current state of a KimonoShape while it is being edited by the user.

+
KimonoShapeText

Draws a block of text into the Design Surface within the specifid bounds of this shape.

+
KimonoShapeTriangle

Draws a triangle into the Design Surface.

+
KimonoShapeVector

A vector is a hard edged shape consisting of a set of datapoints that will be drawn into the Desing Surface.

+
KimonoProperty

Defines a property that can be attached to another Kimono object (such as a KimonoColor, KimonoStyle or KimonoShape) and be used as a local variable, global variable or a parameter or be the result of a calculation using the Obi Simple Scripting Language.

+
KimonoPropertyUsage

Defines how a KimonoProperty is used when it is attached to a KimonoShape, KimonoSketch or KimonoPortfolio.

+
KimonoPropertyConnectionPoint

Defines the point that a KimonoProperty value can be connected to another Kimono object such as the Top coordinate of a KimonoShape.

+
KimonoPropertyConnection

Defines a connection between a given Kimono Object and a KimonoProperty.

+
ObiScriptResult

Defines the result of attempting to execute an Obi Script on a KimonoProperty

+
KimonoBezierPoint

Holds the control and end point for a KimonoShapeBezier that define a quad section of the Bezier.

+
KimonoBounds

Defines the outter bounding box for a KimonoShape and contains the routines required to draw the bounds and the control handles as the user edits and moves the shape.

+
KimonoHandle

Defines an edit handle that the user manipulates to edit the bounds of a KimonoShape or the control points of a Bezier object.

+
KimonoHandleConstraint

Constrains the movement of a KimonoHandle when it is being moved by the user.

+
KimonoHandleType

Defines the type of a KimonoHandle that can be used as a general purpose control point to adjust the bounds of a KimonoShape or as a point for a vector or bezier object.

+
KimonoBlur

Defines a blur effect that can be attached to the fill or the frame of a KimonoShape.

+
KimonoShadow

Defines a shadow effect that can be attached to the fill or the frame of a KimonoShape.

+
KimonoGradient

Defines a gradient as a collection of either SKColor or linked KimonoColors that can be applied to a KimonoStyle and used when drawing a KimonoShape.

+
KimonoGradientType

Kimono gradient type.

+
KimonoStyle

Defines as style that can be applied to a KimonoShape to control its appearance.

+
KimonoStyleType

Defines the type of a KimonoStyle that will be used to draw a given KimonoShape in.

+
KimonoPropertyRect

Defines a KimonoProperty that represents a SKRect.

+
KimonoPropertyNumber

Defines a KimonoProperty that represents a float or int value.

+
KimonoPropertyStyle

Defines a KimonoProperty that represents a KimonoStyle value.

+
KimonoPropertyBoolean

Defines a KimonoProperty that represents a bool value.

+
KimonoPropertyText

Defines a KimonoProperty that represents a string value.

+
KimonoPropertyColor

Defines a KimonoProperty that represents a KimonoColor value.

+
KimonoPropertyGradient

Defines a KimonoProperty that represents a KimonoGradient value.

+
CodeOutputOS

Defines the OS that code will be generated for

+
CodeOutputLanguage

Defines the language that code will be output in.

+
CodeOutputLibrary

Code output library.

+
KimonoCodeGenerator

The Kimono Code Generator has routine to assist in the generation of output source code.

+
IKimonoCodeGeneration

Interface for any Kimono Object that support source code generation.

+

+ + +--- + + +## KimonoCore.Kimono + +

TypeSummary
PortfolioEventDelegate

Portfolio event delegate.

+
SketchEventDelegate

Sketch event delegate.

+
StyleEventDelegate

Style event delegate.

+
ShapeEventDelegate

Shape event delegate.

+
ToolEventDelegate

Tool event delegate.

+
SkiaPointEventDelegate

Skia point event delegate.

+
GroupEventDelegate

Group event delegate.

+
ColorEventDelegate

Color event delegate.

+
SkiaColorEventDelegate

Skia color event delegate.

+
GradientEventDelegate

Gradient event delegate.

+
HandleEventDelegate

Handle event delegate.

+
PropertyEventDelegate

Property event delegate.

+

+ + +# Types + + +--- + + +## KimonoSketch + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Holds a collection of `KimonoShapes` that are used to create a given image using Skia. +

FieldsSummary
ShapeUnderConstruction

+ShapeUnderConstruction

+ +

Added In API Version 01.00.00

+ +

The shape under construction.

+
PreviousSize

+PreviousSize

+ +

Added In API Version 01.00.00

+ +

The size of the previous of a sketch for a rezise operation.

+
Size

+Size

+ +

Added In API Version 01.00.00

+ +

The current size of the sketch

+
_tool

+_tool

+ +

Added In API Version 01.00.00

+ +

The currently KimonoTool that will be used to edit the sketch.

+
_canvasColor

+_canvasColor

+ +

Added In API Version 01.00.00

+ +

The color of the canvas.

+
_selectedShape

+_selectedShape

+ +

Added In API Version 01.00.00

+ +

The selected shape.

+
IgnoreDrag

+IgnoreDrag

+ +

Added In API Version 01.00.00

+ +

If true, the next drag event will be ignored.

+
PerformingDrag

+PerformingDrag

+ +

Added In API Version 01.00.00

+ +

If true, the user is performing a drag operation.

+
ToolDownAt

+ToolDownAt

+ +

Added In API Version 01.00.00

+ +

The last point that a KimonoTool went down on the sketch's Design Surface.

+

+ +

PropertiesSummary
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
Portfolio

+ +

Portfolio

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the portfolio that this sketch belongs to.

+ +

Return Value

+ +

The parent KimonoPortfolio.

+
ElementName

+ +

ElementName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the element as it will be called in generated source code.

+ +

Return Value

+ +

The name of the element.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
GenerateCodeToOuputToCanvas

+ +

GenerateCodeToOuputToCanvas

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

When converting this Sketch to source code, ouput a method that draws into the given SkiaSharp Canvas.

+ +

Return Value

+ +

true if generate code to ouput to canvas; otherwise, false.

+
GenerateCodeToOuputSkiaData

+ +

GenerateCodeToOuputSkiaData

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

When converting this Sketch to source code, output a method that returns the SkiaSharp Data (SKData[]) representing the Sketch.

+ +

Return Value

+ +

true if generate code to ouput skia data; otherwise, false.

+
GenerateCodeToOuputBitmapImage

+ +

GenerateCodeToOuputBitmapImage

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

When converting this Sketch to source code, output a method that returns the Sketch as a OS specific bitmap image.

+ +

Return Value

+ +

true if generate code to ouput bitmap image; otherwise, false.

+
GenerateCodeToOuputToSkiaSharpViews

+ +

GenerateCodeToOuputToSkiaSharpViews

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

When converting this Sketch to source code, output a method that returns the Sketch as class based on the SkiaSharp.Views extension library.

+ +

Return Value

+ +

true if generate code to ouput to skia sharp views; otherwise, false.

+
Width

+ +

Width

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the width.

+ +

Return Value

+ +

The width.

+
Height

+ +

Height

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the height.

+ +

Return Value

+ +

The height.

+
CanvasColor

+ +

CanvasColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color of the canvas.

+ +

Return Value

+ +

The color of the canvas.

+
DrawCanvas

+ +

DrawCanvas

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoSketch should draw the canvas when it is included in another sketch.

+ +

Return Value

+ +

true if draw canvas; otherwise, false.

+
Shapes

+ +

Shapes

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the shapes.

+ +

Return Value

+ +

The shapes.

+
Tool

+ +

Tool

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the tool.

+ +

Return Value

+ +

The tool.

+
SelectedShape

+ +

SelectedShape

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the selected shape.

+ +

Return Value

+ +

The selected shape.

+
DeeplySelectedShape

+ +

DeeplySelectedShape

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the deepest selected shape in a chain of groups.

+ +

Return Value

+ +

The deeply selected shape.

+
DeeplySelectedGroup

+ +

DeeplySelectedGroup

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the deepest selected group in a chain of groups that is in the edit mode.

+ +

Return Value

+ +

The deeply selected group.

+
SelectedShapeAtBottom

+ +

SelectedShapeAtBottom

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selected shape is at the bottom.

+ +

Return Value

+ +

true if selected shape at bottom; otherwise, false.

+
SelectedShapeAtTop

+ +

SelectedShapeAtTop

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selected shape is at the top.

+ +

Return Value

+ +

true if selected shape at top; otherwise, false.

+
CanAlignShapes

+ +

CanAlignShapes

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether alignment can be applied on a set of shapes.

+ +

Return Value

+ +

true if can align shapes; otherwise, false.

+
CanGroupShapes

+ +

CanGroupShapes

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selection of shapes can be grouped.

+ +

Return Value

+ +

true if can group shapes; otherwise, false.

+
CanUngroupShapes

+ +

CanUngroupShapes

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selection of shapes can be ungrouped.

+ +

Return Value

+ +

true if can group shapes; otherwise, false.

+

+ +

MethodsSummary
KimonoSketch

+ +

KimonoSketch ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoSketch class.

+
KimonoSketch

+ +

KimonoSketch (System.String, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoSketch class.

+ +

ParameterSummary
name

+Name.

+
width

+Width.

+
height

+Height.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
SavePreviousSize

+ +

SavePreviousSize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Saves the previous size of the sketch.

+
ApplySizeChange

+ +

ApplySizeChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the size change.

+
RemovePropertyConnection

+ +

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the property connection.

+ +

ParameterSummary
connection

+The KimonoPropertyConnection to remove.

+

+
RemoveProperty

+ +

RemoveProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes any connection using this property.

+ +

ParameterSummary
property

+The KimonoProperty to remove.

+

+
FindShape

+ +

FindShape (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the shape specified by its unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

If found, the KimonoShape will be returned, else null.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draw this sketch into the give SkiaSharp canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
MoveSelectedShapeToBottom

+ +

MoveSelectedShapeToBottom ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape to bottom.

+
MoveSelectedShapeBackwards

+ +

MoveSelectedShapeBackwards ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape backwards.

+
MoveSelectedShapeToTop

+ +

MoveSelectedShapeToTop ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape to top.

+
MoveSelectedShapeForwards

+ +

MoveSelectedShapeForwards ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape forwards.

+
AddShape

+ +

AddShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the shape.

+ +

ParameterSummary
shape

+The KimonoShape to add.

+

+
RecalculateLayerDepths

+ +

RecalculateLayerDepths ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Recalculates the layer depths.

+ +

Remarks

+ +

Layer depths are used to maintain the front to back order of the KimonoShapes that for the sketch.

+
DuplicateSelectedShape

+ +

DuplicateSelectedShape ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the selected shape.

+
DeleteSelectedShape

+ +

DeleteSelectedShape ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the selected shape.

+
SelectShape

+ +

SelectShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Selects the given shape.

+ +

ParameterSummary
shape

+The KimonoShape to select.

+

+
DeselectAll

+ +

DeselectAll ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deselects all shapes in the sketch.

+
GroupUngroupSelectedShapes

+ +

GroupUngroupSelectedShapes ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Groups or ungroups the currently selected group of shapes based on the current selection type.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
BuildCsharpToCanvasMethod

+ +

BuildCsharpToCanvasMethod (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Build the method to draw into a specific SkiaSharp Canvas in C# source code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The source code for the method.

+
BuildCsharpToSkiaDataMethod

+ +

BuildCsharpToSkiaDataMethod (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Bulids the method to convert this Sketch to SkiaSharp data (SKData).

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The Sketch as SKData.

+
BuildCsharpToBitmapImage

+ +

BuildCsharpToBitmapImage (KimonoCore.CodeOutputOS)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Bulids the method to convert this Sketch to OS specific bitmap image format.

+ +

ParameterSummary
outputOS

+Output os.

+

+ +

Returns

+ +

Sketch as a platform specific image.

+
BuildCSharpCrossPlatformToImage

+ +

BuildCSharpCrossPlatformToImage (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Builds the C# ToImage method for Cross Platform image support.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

Conditionally compiled code to support all of the different image types.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCSharpUsingStatements

+ +

ToCSharpUsingStatements (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Builds the C# using statements.

+ +

ParameterSummary
outputOS

+The CodeOutputOS to write code for.

+
outputLibrary

+Output library.

+

+ +

Returns

+ +

The required using statements based on what other features have been selected.

+
PortfolioSketchMethods

+ +

PortfolioSketchMethods (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary, System.String@, System.String@)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the methods that a portfolio will use to draw the sketch.

+ +

ParameterSummary
outputOS

+The CodeOutputOS to generate code for.

+
outputLibrary

+The CodeOutputLibrary to use.

+
privateMethodsCode

+The private methods required by this sketch.

+
publicMethodsCode

+The public methods required by this sketch.

+

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCSharpKimono

+ +

ToCSharpKimono (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this sketch to C# code using the KimonoCore library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS to create code for.

+
outputLanguage

+The CodeOutputLanguage to use.

+
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The sketch as source code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
RelinkShape

+ +

RelinkShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the given shape after a clone operation.

+ +

ParameterSummary
shape

+The KimonoShape to relink.

+

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

A deep clone of this KimonoSketch.

+
ToolDown

+ +

ToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user placing the current KimonoTool down on the sketch's Design Surface.

+ +

ParameterSummary
point

+The SKPoint where the tool went down on the Design Surface.

+
clicks

+The number of time the user clicked/tapped the tool down on the Design Surface.

+
multiSelect

+If true, the user has started a multi-shape select process.

+

+
ToolDrag

+ +

ToolDrag (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handle the user dragging the selected KimonoTool on the sketch's Design Surface.

+ +

ParameterSummary
point

+The SKPoint representing the new tool position on the Design Surface.

+

+
ToolUp

+ +

ToolUp (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user lifting the current KimonoTool off of the sketch's Design Surface.

+ +

ParameterSummary
point

+The SKPoint where the user lifted up the tool.

+

+
RaiseRequestNewUndoPoint

+ +

RaiseRequestNewUndoPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the request new undo point event.

+
RaiseSketchSizeChanged

+ +

RaiseSketchSizeChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the sketch size changed event.

+
RaiseSketchModified

+ +

RaiseSketchModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the sketch modified event.

+
RaiseImageBufferNeedsRefresh

+ +

RaiseImageBufferNeedsRefresh ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the image buffer needs refresh event.

+
RaiseSelectedShapeModified

+ +

RaiseSelectedShapeModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the selected shape modified event.

+
RaiseSelectionChanged

+ +

RaiseSelectionChanged (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the selection changed event.

+ +

ParameterSummary
selected

+Selected.

+

+
RaiseToolChanged

+ +

RaiseToolChanged (KimonoCore.KimonoTool)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the tool changed event.

+ +

ParameterSummary
tool

+The new KimonoTool that has been selected.

+

+

+ +

EventsSummary
RequestNewUndoPoint

+ +

RequestNewUndoPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when a new undo point is requested.

+
SketchSizeChanged

+ +

SketchSizeChanged

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when sketch size changed.

+
SketchModified

+ +

SketchModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when sketch modified.

+
ImageBufferNeedsRefresh

+ +

ImageBufferNeedsRefresh

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when image buffer needs refresh.

+
SelectedShapeModified

+ +

SelectedShapeModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when selected shape is modified.

+
SelectionChanged

+ +

SelectionChanged

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when selection changed.

+
ToolChanged

+ +

ToolChanged

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when tool changed.

+

+ + +--- + + +## KimonoTool + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the current tool that is active in a `KimonoSketch` that the user can use to create or modify a `KimonoShape`. +

FieldsSummary
Cursor

+Cursor

+ +

Added In API Version 01.00.00

+ +

Use the Cursor tool to modify an existing KimonoShape.

+
Line

+Line

+ +

Added In API Version 01.00.00

+ +

Use the Line tool to add a new KimonoShapeLine to the sketch.

+
Arrow

+Arrow

+ +

Added In API Version 01.00.00

+ +

Use the Arrow tool to add a new KimonoShapeArrow to the sketch.

+
Rectangle

+Rectangle

+ +

Added In API Version 01.00.00

+ +

Use the Rectangle tool to add a new KimonoShapeRect to the sketch.

+
Oval

+Oval

+ +

Added In API Version 01.00.00

+ +

Use the Oval tool to add a new KimonoShapeOval to the sketch.

+
RoundRect

+RoundRect

+ +

Added In API Version 01.00.00

+ +

Use the Round Rect tool to add a new KimonoShapeRoundRect to the sketch.

+
Star

+Star

+ +

Added In API Version 01.00.00

+ +

Use the Star tool to add a new KimonoShapeStar to the sketch.

+
Polygon

+Polygon

+ +

Added In API Version 01.00.00

+ +

Use the Polygon tool to add a new KimonoShapePolygon to the sketch.

+
Triangle

+Triangle

+ +

Added In API Version 01.00.00

+ +

Use the Triangle tool to add a new KimonoShapeTriangle to the sketch.

+
Vector

+Vector

+ +

Added In API Version 01.00.00

+ +

Use the Vector tool to add a new KimonoShapeVector to the sketch.

+
Bezier

+Bezier

+ +

Added In API Version 01.00.00

+ +

Use the Bezier tool to add a new KimonoShapeBezier to the sketch.

+
Text

+Text

+ +

Added In API Version 01.00.00

+ +

Use the Text tool to add a new KimonoShapeText to the sketch.

+

+ + +--- + + +## Kimono + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Holds a set of shared utilities that are used across the Kimono classes. +

MethodsSummary
CharIsNumber

+ +

CharIsNumber (System.Char)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given character is a number character.

+ +

ParameterSummary
c

+C.

+

+ +

Returns

+ +

true, if is character is a number, false otherwise.

+
CharIsLetter

+ +

CharIsLetter (System.Char)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given character is a letter character.

+ +

ParameterSummary
c

+C.

+

+ +

Returns

+ +

true, if is letter was chared, false otherwise.

+
IncrementName

+ +

IncrementName (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Increments the name by appending a number to the end or incrementing an existing number count.

+ +

ParameterSummary
name

+Name.

+

+ +

Returns

+ +

The name.

+
CloneSKPoint

+ +

CloneSKPoint (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clones the given SKPoint.

+ +

ParameterSummary
point

+The SKPoint to clone.

+

+ +

Returns

+ +

A clone of the given point.

+

+ + +--- + + +## PortfolioEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Portfolio event delegate. + +--- + + +## SketchEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Sketch event delegate. + +--- + + +## StyleEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Style event delegate. + +--- + + +## ShapeEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Shape event delegate. + +--- + + +## ToolEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Tool event delegate. + +--- + + +## SkiaPointEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Skia point event delegate. + +--- + + +## GroupEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Group event delegate. + +--- + + +## ColorEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Color event delegate. + +--- + + +## SkiaColorEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Skia color event delegate. + +--- + + +## GradientEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Gradient event delegate. + +--- + + +## HandleEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Handle event delegate. + +--- + + +## PropertyEventDelegate + +### Namespace + +[KimonoCore.Kimono](#6cf3de51-1a6a-406c-9f4a-346b48f2fbe1) + +### Added In API Version + +01.00.00 + +### Summary + +Property event delegate. + +--- + + +## KimonoPortfolio + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +A Kimono Portfolio holds a collection of `KimonoSketches`, `KimonoStyles` and `KimonoColors` that define a given Kimono Designer project. +

FieldsSummary
_selectedSketch

+_selectedSketch

+ +

Added In API Version 01.00.00

+ +

The currently selected sketch.

+
NewSketchNumber

+NewSketchNumber

+ +

Added In API Version 01.00.00

+ +

Holds the number that will be assigned to the next new KimonoSketch created in this portfolio.

+

+ +

PropertiesSummary
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
ElementName

+ +

ElementName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the element as it will be called in generated source code.

+ +

Return Value

+ +

The name of the element.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
Namespace

+ +

Namespace

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the namespace.

+ +

Return Value

+ +

The namespace.

+
Author

+ +

Author

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the author.

+ +

Return Value

+ +

The author.

+
Copyright

+ +

Copyright

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the copyright.

+ +

Return Value

+ +

The copyright.

+
Sketches

+ +

Sketches

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the sketches.

+ +

Return Value

+ +

The sketches.

+
Styles

+ +

Styles

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the styles.

+ +

Return Value

+ +

The styles.

+
Colors

+ +

Colors

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the colors.

+ +

Return Value

+ +

The colors.

+
Gradients

+ +

Gradients

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the gradients.

+ +

Return Value

+ +

The gradients.

+
Properties

+ +

Properties

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the properties.

+ +

Return Value

+ +

The properties.

+
SelectedSketch

+ +

SelectedSketch

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the selected sketch.

+ +

Return Value

+ +

The selected sketch.

+

+ +

MethodsSummary
KimonoPortfolio

+ +

KimonoPortfolio (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPortfolio class.

+ +

ParameterSummary
initialize

+If true, the new instance will be initialized with the default values.

+

+ +

Remarks

+ +

initialize is set to false when a clone is being made of given KimonoPortfolio.

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
FindSketch

+ +

FindSketch (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the given KimonoSketch by its Unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoSketch if found, else null.

+
FindColor

+ +

FindColor (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the given KimonoColor by its unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoColor if found, else null.

+
FindProperty

+ +

FindProperty (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the given KimonoProperty by its unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoProperty if founs, else null.

+
FindGradient

+ +

FindGradient (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the gradient by its unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoGradient if found, else null.

+
FindStyle

+ +

FindStyle (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the given KimonoStyle by its Unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoStyle if found, else null.

+
AddNewSketch

+ +

AddNewSketch ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the a new KimonoSketch to this portfolio.

+
DuplicateSelectedSketch

+ +

DuplicateSelectedSketch ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the selected sketch.

+
DeleteSelectedSketch

+ +

DeleteSelectedSketch ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the selected sketch.

+
AddNewGradient

+ +

AddNewGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the new gradient.

+ +

Returns

+ +

The new gradient.

+
AddNewColor

+ +

AddNewColor ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new KimonoColor to this portfolio.

+ +

Returns

+ +

The new KimonoColor.

+
AddNewColor

+ +

AddNewColor (SkiaSharp.SKColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new KimonoColor to this portfolio based off of a given SKColor.

+ +

ParameterSummary
baseColor

+Base color.

+

+ +

Returns

+ +

The new KimonoColor.

+
AddPropertyBoolean

+ +

AddPropertyBoolean ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new boolean property.

+ +

Returns

+ +

The new KimonoPropertyBoolean.

+
AddPropertyColor

+ +

AddPropertyColor ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new color property.

+ +

Returns

+ +

The new KimonoPropertyColor.

+
AddPropertyGradient

+ +

AddPropertyGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new gradient property.

+ +

Returns

+ +

The new KimonoPropertyGradient.

+
AddPropertyNumber

+ +

AddPropertyNumber ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new number property.

+ +

Returns

+ +

The new KimonoPropertyNumber.

+
AddPropertyRect

+ +

AddPropertyRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new rect property.

+ +

Returns

+ +

The new KimonoPropertyRect.

+
AddPropertyStyle

+ +

AddPropertyStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new style property.

+ +

Returns

+ +

The new KimonoPropertyStyle.

+
AddPropertyText

+ +

AddPropertyText ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new text property.

+ +

Returns

+ +

The new KimonoPropertyText.

+
AddNewProperty

+ +

AddNewProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given KimonoProperty to this portfolio

+ +

ParameterSummary
property

+The KimonoProperty to add.

+

+
DuplicateColor

+ +

DuplicateColor (KimonoCore.KimonoColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the given KimonoColor and adds it to the portfolio's collection of colors.

+ +

ParameterSummary
color

+The KimonoColor to duplicate.

+

+
DuplicateProperty

+ +

DuplicateProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the property.

+ +

ParameterSummary
property

+The KimonoProperty to duplicate.

+

+ +

Returns

+ +

The new KimonoProperty.

+
DuplicateGradient

+ +

DuplicateGradient (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the gradient.

+ +

ParameterSummary
gradient

+The KimonoGradient to duplicate.

+

+
DeleteColor

+ +

DeleteColor (KimonoCore.KimonoColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given KimonoColor from the portfolio.

+ +

ParameterSummary
color

+The KimonoColor to delete.

+

+
DeleteGradient

+ +

DeleteGradient (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given gradient from the portfolio.

+ +

ParameterSummary
gradient

+The KimonoGradient to delete.

+

+
DeleteProperty

+ +

DeleteProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given property.

+ +

ParameterSummary
property

+The KimonoProperty to delete.

+

+
AddNewStyle

+ +

AddNewStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the a new KimonoStyle to the portfolio.

+
DuplicateStyle

+ +

DuplicateStyle (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the given KimonoStyle adding it to the portfolio's collection of styles.

+ +

ParameterSummary
style

+The KimonoStyle to duplicate.

+

+
ConvertSelectedShapeToStyle

+ +

ConvertSelectedShapeToStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Takes the custom KimonoStyle of the currently selected KimonoShape, converts it to a named, shared style and adds it to the portfolio's collection of styles.

+
DeleteStyle

+ +

DeleteStyle (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given KimonoStyle from the portfolio's collection of styles.

+ +

ParameterSummary
style

+Style.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCSharpUsingStatements

+ +

ToCSharpUsingStatements (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Builds the C# using statements.

+ +

ParameterSummary
outputOS

+The CodeOutputOS to write code for.

+
outputLibrary

+Output library.

+

+ +

Returns

+ +

The required using statements based on what other features have been selected.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCSharpKimono

+ +

ToCSharpKimono (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this sketch to C# code using the KimonoCore library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS to create code for.

+
outputLanguage

+The CodeOutputLanguage to use.

+
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The sketch as source code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
RelinkColors

+ +

RelinkColors ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the colors after a clone operation.

+
RelinkGradient

+ +

RelinkGradient (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the gradient after a clone operation.

+ +

ParameterSummary
gradient

+The KimonoGradient to relink.

+

+
RelinkStyle

+ +

RelinkStyle (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the given KimonoStyle after a clone operation.

+ +

ParameterSummary
style

+The KimonoStyle to relink.

+

+
RelinkShape

+ +

RelinkShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the given KimonoShape after a clone operation.

+ +

ParameterSummary
shape

+The KimonoShape to relink.

+

+
RelinkSketch

+ +

RelinkSketch (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the given KimonoSketch after a clone operation.

+ +

ParameterSummary
sketch

+The KimonoSketch to relink.

+

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

A deep clone of this KimonoPortfolio.

+
RaisePropertyModified

+ +

RaisePropertyModified (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the property modified event.

+ +

ParameterSummary
property

+The KimonoProperty that was modified.

+

+
RaiseGradientsModified

+ +

RaiseGradientsModified (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the gradients modified event.

+ +

ParameterSummary
gradient

+The KimonoGradient that was modified.

+

+
RaiseRequestNewUndoPoint

+ +

RaiseRequestNewUndoPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the request new undo point event.

+
RaiseSketchesModified

+ +

RaiseSketchesModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the sketches modified event.

+
RaiseSelectedSketchWillChange

+ +

RaiseSelectedSketchWillChange (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the selected sketch will change event.

+ +

ParameterSummary
sketch

+The KimonoSketch that will change.

+

+
RaiseSelectedSketchDidChange

+ +

RaiseSelectedSketchDidChange (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the selected sketch did change event.

+ +

ParameterSummary
sketch

+The KimonoSketch that did change.

+

+
RaiseStylesModified

+ +

RaiseStylesModified (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the styles modified event.

+ +

ParameterSummary
style

+The KimonoStyle that was modified.

+

+
RaiseSelectedShapeChanged

+ +

RaiseSelectedShapeChanged (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the selected shape changed event.

+ +

ParameterSummary
selected

+The new KimonoShape that was selected.

+

+
RaiseColorsModified

+ +

RaiseColorsModified (KimonoCore.KimonoColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the colors modified event.

+ +

ParameterSummary
color

+The KimonoColor that was modified.

+

+

+ +

EventsSummary
RequestNewUndoPoint

+ +

RequestNewUndoPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when a new undo point is requested.

+
SketchesModified

+ +

SketchesModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when sketches collection is modified.

+
SelectedSketchWillChange

+ +

SelectedSketchWillChange

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when selected sketch will change.

+
SelectedSketchDidChange

+ +

SelectedSketchDidChange

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when selected sketch did change.

+
StylesModified

+ +

StylesModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when styles collection is modified.

+
SelectedShapeChanged

+ +

SelectedShapeChanged

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when selected shape changed.

+
ColorsModified

+ +

ColorsModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when colors collection is modified.

+
GradientsModified

+ +

GradientsModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when gradients collection is modified.

+
PropertyModified

+ +

PropertyModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when property collection is modified.

+

+ + +--- + + +## KimonoUndoHandler + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Handles the undo/redo state for a `KimonoDesignSurface`. +

PropertiesSummary
MaximumUndoPoints

+ +

MaximumUndoPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the maximum undo points.

+ +

Return Value

+ +

The maximum undo points.

+
UndoStack

+ +

UndoStack

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the undo stack.

+ +

Return Value

+ +

The undo stack.

+
RedoStack

+ +

RedoStack

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the redo stack.

+ +

Return Value

+ +

The redo stack.

+
CanUndo

+ +

CanUndo

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the user can undo their last action.

+ +

Return Value

+ +

true if can undo; otherwise, false.

+
CanRedo

+ +

CanRedo

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the user can redo their last action.

+ +

Return Value

+ +

true if can redo; otherwise, false.

+

+ +

MethodsSummary
KimonoUndoHandler

+ +

KimonoUndoHandler ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoUndoHandler class.

+
PushUndoPoint

+ +

PushUndoPoint (KimonoCore.KimonoPortfolio)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Pushes the undo point onto the stack.

+ +

ParameterSummary
portfolio

+The current state of the KimonoPortfolio.

+

+
ReplaceLastUndoPoint

+ +

ReplaceLastUndoPoint (KimonoCore.KimonoPortfolio)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Replaces the last undo point with the one being passed in.

+ +

ParameterSummary
portfolio

+The current state of the KimonoPortfolio.

+

+
PopUndoPoint

+ +

PopUndoPoint (KimonoCore.KimonoPortfolio)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Pops the undo point off the stack.

+ +

ParameterSummary
portfolio

+The current state of the KimonoPortfolio.

+

+ +

Returns

+ +

The prior state of the KimonoPortfolio.

+
PopRedoPoint

+ +

PopRedoPoint (KimonoCore.KimonoPortfolio)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Pops the redo point off the stack.

+ +

ParameterSummary
portfolio

+The current state of the KimonoPortfolio.

+

+ +

Returns

+ +

The previous state of the KimonoPortfolio.

+
RaiseUndoStateChanged

+ +

RaiseUndoStateChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the undo state changed event.

+

+ +

EventsSummary
UndoStateChanged

+ +

UndoStateChanged

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when undo state changed.

+

+ + +--- + + +## KimonoShape + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the based shape that all other Kimono Shape types will inherit from. +

FieldsSummary
_name

+_name

+ +

Added In API Version 01.00.00

+ +

The default name of the shape.

+
_style

+_style

+ +

Added In API Version 01.00.00

+ +

The default, custom KimonoStyle that is attached to the shape.

+
_visible

+_visible

+ +

Added In API Version 01.00.00

+ +

The visibility of the shape.

+

+ +

PropertiesSummary
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
ElementName

+ +

ElementName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the element as it will be called in generated source code.

+ +

Return Value

+ +

The name of the element.

+
Style

+ +

Style

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the style.

+ +

Return Value

+ +

The KimonoStyle that will be used to draw this shape.

+
ControlPoints

+ +

ControlPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the control points that define the path of the shape.

+ +

Return Value

+ +

A collection of KimonoHandle objects.

+
Visible

+ +

Visible

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShape is visible.

+ +

Return Value

+ +

true if visible; otherwise, false.

+
IsEditable

+ +

IsEditable

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoShape is editable.

+ +

Return Value

+ +

true if is editable; otherwise, false.

+ +

Remarks

+ +

An "Editable Shape" is one that is composed of a set of data points (such as KimonoVector or KimonoBezier) or a group of objects (such as KimonoShapeGroup).

+
LayerDepth

+ +

LayerDepth

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the layer depth from the bottom to the top controlling how shapes are overlapping on the design surface.

+ +

Return Value

+ +

The layer depth.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+
PropertyConnections

+ +

PropertyConnections

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the list of KimonoProperty objects connected to the various KimonoPropertyConnectionPoints that will need to be evaulated before drawing this KimonoShape.

+ +

Return Value

+ +

The property connections.

+

+ +

MethodsSummary
KimonoShape

+ +

KimonoShape ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShape class.

+
KimonoShape

+ +

KimonoShape (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShape class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShape

+ +

KimonoShape (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShape class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
AddPropertyConnection

+ +

AddPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Connects the given KimonoProperty to the given KimonoPropertyConnectionPoint on this KimonoShape.

+ +

ParameterSummary
connectionPoint

+The KimonoPropertyConnectionPoint to connect to.

+
property

+The KimonoProperty to connect.

+

+
RemovePropertyConnection

+ +

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the property connection.

+ +

ParameterSummary
connection

+The KimonoPropertyConnection to remove.

+

+
RemoveProperty

+ +

RemoveProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes any connection using this property.

+ +

ParameterSummary
property

+The KimonoProperty to remove.

+

+
EvaluateConnectedProperties

+ +

EvaluateConnectedProperties ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluates all of the KimonoProperty objects attached to this KimonoShape by executling their Obi Scripts and updating the values with the results.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
StartEditing

+ +

StartEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Places the shape in the editing mode.

+
EndEditing

+ +

EndEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Ends the editing mode.

+
UncoupleDeletedStyle

+ +

UncoupleDeletedStyle (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Uncouples the deleted style from the shape.

+ +

ParameterSummary
deletedStyle

+The KimonoStyle to delete.

+

+
ConformGradientToShape

+ +

ConformGradientToShape (KimonoCore.KimonoGradient, SkiaSharp.SKPaint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Conforms the gradient to shape by fitting it to the bounds of the shape.

+ +

ParameterSummary
gradient

+The KimonoGradient to conform.

+
paint

+The SKPaint that the gradient is being attached to.

+

+
ToVector

+ +

ToVector ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a vector.

+ +

Returns

+ +

The shape as a KimonoVector.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
StyleFillPaintForCode

+ +

StyleFillPaintForCode (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the style fill paint for code.

+
StyleFramePaintForCode

+ +

StyleFramePaintForCode (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the style frame paint for code.

+
ConformedFillGradientCode

+ +

ConformedFillGradientCode (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Conforms the attached gradient to the shapes bounds for code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The fill gradient conformed in code.

+
ConformedFrameGradientCode

+ +

ConformedFrameGradientCode (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Conforms the attached gradient to the shapes bounds for code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The frame gradient conformed in code.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
CloneAttachedStyle

+ +

CloneAttachedStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clones the attached style.

+ +

Returns

+ +

A duplicate KimonoStyle.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone of this shape as a base KimonoBounds.

+

+ + +--- + + +## KimonoShapeArrow + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws either an outlined or single line arrow with heads on one or both ends. +

PropertiesSummary
HasStartHead

+ +

HasStartHead

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeArrow has start head.

+ +

Return Value

+ +

true if has start head; otherwise, false.

+
HasEndHead

+ +

HasEndHead

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeArrow has end head.

+ +

Return Value

+ +

true if has end head; otherwise, false.

+
HeadInnerRatio

+ +

HeadInnerRatio

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the head inner ratio.

+ +

Return Value

+ +

The head inner ratio.

+
HeadOuterRatio

+ +

HeadOuterRatio

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the head outer ratio.

+ +

Return Value

+ +

The head outer ratio.

+
IsStreamlined

+ +

IsStreamlined

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeArrow is streamlined.

+ +

Return Value

+ +

true if is streamlined; otherwise, false.

+ +

Remarks

+ +

A Streamlined Arrow, is drawn as a single line.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+

+ +

MethodsSummary
KimonoShapeArrow

+ +

KimonoShapeArrow ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeArrow class.

+
KimonoShapeArrow

+ +

KimonoShapeArrow (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeArrow class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeArrow

+ +

KimonoShapeArrow (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeArrow class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the arrow to a path.

+ +

Returns

+ +

The the arrow as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the arrow into the specified Skia canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
GrowBounds

+ +

GrowBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Grows the bounds of the arrow.

+ +

ParameterSummary
point

+The SKPoint containing the bounds adjustment.

+

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds of the arrow to a new location.

+ +

ParameterSummary
point

+The SKPoint specifying the new location of the bounds.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone of the KimonoArrow.

+

+ + +--- + + +## KimonoShapeBezier + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +A Kimono Bezier is a collection of control and end points that define the quad sections of a bezier shape to be drawn using SkiaSharp. +

PropertiesSummary
Points

+ +

Points

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the points that define the shape.

+ +

Return Value

+ +

The points.

+
Closed

+ +

Closed

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeVector is closed.

+ +

Return Value

+ +

true if closed; otherwise, false.

+
IsEditable

+ +

IsEditable

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoShapeVector is editable.

+ +

Return Value

+ +

true if is editable; otherwise, false.

+
LastPoint

+ +

LastPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the last point in the collection of control points.

+ +

Return Value

+ +

The last point.

+

+ +

MethodsSummary
KimonoShapeBezier

+ +

KimonoShapeBezier ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeBezier class.

+
KimonoShapeBezier

+ +

KimonoShapeBezier (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeBezier class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeBezier

+ +

KimonoShapeBezier (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeBezier class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
RecalculateVectorBounds

+ +

RecalculateVectorBounds ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Recalculates the vector bounds to encompas all of the data points that define the shape.

+
AddPoint

+ +

AddPoint (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a point to the shape.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+

+
AddPoint

+ +

AddPoint (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the point to the shape.

+ +

ParameterSummary
controlX

+Control x.

+
controlY

+Control y.

+
endX

+End x.

+
endY

+End y.

+

+
AddPoint

+ +

AddPoint (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given point to the shape.

+ +

ParameterSummary
point

+The new SKPoint to add.

+

+
AddHandlesForPoint

+ +

AddHandlesForPoint (System.Int32, KimonoCore.KimonoBezierPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the handles for the given bezier point.

+ +

ParameterSummary
index

+The index of the KimonoBezierPoint that handles are being created for.

+
bezierPoint

+The KimonoBezierPoint that is getting handles.

+

+
MoveLastPoint

+ +

MoveLastPoint (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the last point added to the new position.

+ +

ParameterSummary
point

+The SKPoint for the new position.

+

+
RemovePoint

+ +

RemovePoint (System.Int32)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the given point.

+ +

ParameterSummary
n

+The index of the point ot remove.

+

+
ApplyMoveAndScale

+ +

ApplyMoveAndScale ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the move and scale amount to the data point that make up the shape.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the shape into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
PointInBound

+ +

PointInBound (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Tests to see if the given point is inside the bounds of the shape.

+ +

ParameterSummary
point

+The SKPoint to test.

+

+ +

Returns

+ +

true, if in bound was pointed, false otherwise.

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds of the shape to a new location.

+ +

ParameterSummary
point

+The SKPoint to drag the bounds to.

+

+
BoundsChanged

+ +

BoundsChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the bounds of the shape being changed.

+
StartEditing

+ +

StartEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Places the shape into the editing mode where the user can adjust the individual data points that define the shape.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeVector.

+

+ + +--- + + +## KimonoShapeGroup + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +A `KimonoShapeGroup` holds a collection of `KimonoShapes` that can be acted upon as a group. +

FieldsSummary
ShapeUnderConstruction

+ShapeUnderConstruction

+ +

Added In API Version 01.00.00

+ +

The shape under construction.

+
_selectedShape

+_selectedShape

+ +

Added In API Version 01.00.00

+ +

The currently selected shape.

+
Dragging

+Dragging

+ +

Added In API Version 01.00.00

+ +

Marks if the group itself is being moved be the user.

+
IgnoreDrag

+IgnoreDrag

+ +

Added In API Version 01.00.00

+ +

If true, the next drag event will be ignored.

+
PerformingDrag

+PerformingDrag

+ +

Added In API Version 01.00.00

+ +

If true, the user is performing a drag operation.

+
ToolDownAt

+ToolDownAt

+ +

Added In API Version 01.00.00

+ +

The last point that a KimonoTool went down on the sketch's Design Surface.

+
_isMaskedGroup

+_isMaskedGroup

+ +

Added In API Version 01.00.00

+ +

If true, the top most shape in the group will act as a mask for the shapes below it.

+

+ +

PropertiesSummary
Parent

+ +

Parent

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the parent KimonoSketch or KimonoShapeGroup that this KimonoShapeGroup belongs to.

+ +

Return Value

+ +

The parent KimonoSketch or KimonoShapeGroup.

+
ParentSketch

+ +

ParentSketch

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the parent sketch by scanning backwards through the chain of parent objects until a KimonoSketch is reached.

+ +

Return Value

+ +

The parent KimonoSketch.

+
Path

+ +

Path

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the full path from this group back to the parent KimonoSketch.

+ +

Return Value

+ +

The path representing the nesting level of this group.

+
Shapes

+ +

Shapes

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the shapes.

+ +

Return Value

+ +

The shapes.

+
SelectedShape

+ +

SelectedShape

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the selected shape.

+ +

Return Value

+ +

The selected shape.

+
DeeplySelectedShape

+ +

DeeplySelectedShape

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the deepest selected shape in a chain of groups.

+ +

Return Value

+ +

The deeply selected shape.

+
DeeplySelectedGroup

+ +

DeeplySelectedGroup

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the deepest selected group in a chain of groups that is in the edit mode.

+ +

Return Value

+ +

The deeply selected group.

+
GroupType

+ +

GroupType

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the type of the group.

+ +

Return Value

+ +

The type of the group as a KimonoShapeGroupType.

+
Style

+ +

Style

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the style of this group.

+ +

Return Value

+ +

The style as a KimonoStyle.

+
Visible

+ +

Visible

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeGroup is visible.

+ +

Return Value

+ +

true if visible; otherwise, false.

+
IsEditable

+ +

IsEditable

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoShapeGroup is editable.

+ +

Return Value

+ +

true if is editable; otherwise, false.

+
SelectedShapeAtBottom

+ +

SelectedShapeAtBottom

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selected shape is at the bottom.

+ +

Return Value

+ +

true if selected shape at bottom; otherwise, false.

+
SelectedShapeAtTop

+ +

SelectedShapeAtTop

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether the selected shape is at the top.

+ +

Return Value

+ +

true if selected shape at top; otherwise, false.

+
IsBooleanConstruct

+ +

IsBooleanConstruct

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeGroup is a boolean construct.

+ +

Return Value

+ +

true if is boolean construct; otherwise, false.

+
BooleanOperation

+ +

BooleanOperation

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the boolean operation that will be applied to this group of objects.

+ +

Return Value

+ +

The boolean operation as a SKPathOp.

+
Mask

+ +

Mask

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the KimonoShape that is acting as a mask for this group.

+ +

Return Value

+ +

The mask as a KimonoShape.

+
IsMaskedGroup

+ +

IsMaskedGroup

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeGroup is masked group.

+ +

Return Value

+ +

true if is masked group; otherwise, false.

+

+ +

MethodsSummary
KimonoShapeGroup

+ +

KimonoShapeGroup (System.Object)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeGroup class.

+ +

ParameterSummary
parent

+The parent KimonoSketch or KimonoShapeGroup.

+

+
KimonoShapeGroup

+ +

KimonoShapeGroup (System.Object, System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeGroup class.

+ +

ParameterSummary
parent

+Parent.

+
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeGroup

+ +

KimonoShapeGroup (System.Object, System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeGroup class.

+ +

ParameterSummary
parent

+Parent.

+
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize (System.Object)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize the specified parent.

+ +

ParameterSummary
parent

+Parent.

+

+ +

Returns

+ +

The initialize.

+
FindShape

+ +

FindShape (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds a given shape by its Unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The KimonoShape if found, else null.

+
RecalculateGroupBounds

+ +

RecalculateGroupBounds ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Recalculates the group bounds to encompass every KimonoShape inside this group.

+
ReturnToSketch

+ +

ReturnToSketch ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns to base parent KimonoSketch for this group.

+
SelectShape

+ +

SelectShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Selects the given KimonoShape.

+ +

ParameterSummary
shape

+Shape.

+

+
RecalculateLayerDepths

+ +

RecalculateLayerDepths ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Recalculates the layer depths.

+ +

Remarks

+ +

Layer depths are used to maintain the front to back order of the KimonoShapes that for the sketch.

+
MoveSelectedShapeToBottom

+ +

MoveSelectedShapeToBottom ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape to bottom.

+
MoveSelectedShapeBackwards

+ +

MoveSelectedShapeBackwards ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape backwards.

+
MoveSelectedShapeToTop

+ +

MoveSelectedShapeToTop ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape to top.

+
MoveSelectedShapeForwards

+ +

MoveSelectedShapeForwards ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the selected shape forwards.

+
AlignAllTop

+ +

AlignAllTop ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Aligns all shapes in the group at the top.

+
AlignAllBottom

+ +

AlignAllBottom ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Aligns all shapes in the group at the bottom.

+
AlignAllLeft

+ +

AlignAllLeft ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Aligns all shapes in the group to the left.

+
AlignAllRight

+ +

AlignAllRight ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Aligns all shapes in the group to the right.

+
AlignAllCenter

+ +

AlignAllCenter ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Centers all shapes in the group.

+
AlignAllCenterHorizontal

+ +

AlignAllCenterHorizontal ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Center horizontal all shapes in the group.

+
AlignAllCenterVertical

+ +

AlignAllCenterVertical ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Center vertical all shapes in the group.

+
DeleteColor

+ +

DeleteColor (KimonoCore.KimonoColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given KimonoColor from this group.

+ +

ParameterSummary
color

+The KimonoColor to delete.

+

+
DeleteGradient

+ +

DeleteGradient (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the given gradient from the group.

+ +

ParameterSummary
gradient

+The KimonoGradient to delete.

+

+
AddShape

+ +

AddShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given KimonoShape to the group if it isn't already a part of the group.

+ +

ParameterSummary
shape

+The KimonoShape to add.

+

+
DuplicateSelectedShape

+ +

DuplicateSelectedShape ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the selected shape.

+
RemoveShape

+ +

RemoveShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the given KimonoShape from the group.

+ +

ParameterSummary
shape

+Shape.

+

+
DeleteSelectedShape

+ +

DeleteSelectedShape ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the selected shape.

+
ShapeInGroup

+ +

ShapeInGroup (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given KimonoShape is a part of this group.

+ +

ParameterSummary
shape

+The KimonoShape to test for.

+

+ +

Returns

+ +

true, if in shape is in the group, false otherwise.

+
DeselectAll

+ +

DeselectAll ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deselects all shapes in this group.

+
GroupShapes

+ +

GroupShapes ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Groups the shapes.

+
GroupShapes

+ +

GroupShapes (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Groups the shapes in the parent sketch.

+ +

ParameterSummary
sketch

+The parent KimonoSketch.

+

+
GroupShapes

+ +

GroupShapes (KimonoCore.KimonoShapeGroup)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Groups the shapes in the parent group.

+ +

ParameterSummary
group

+The parent KimonoShapeGroup.

+

+
UngroupShapes

+ +

UngroupShapes ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Ungroups the shapes in this group.

+
UngroupShapes

+ +

UngroupShapes (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Ungroups the shapes in the parent sketch.

+ +

ParameterSummary
sketch

+The parent KimonoSketch.

+

+
UngroupShapes

+ +

UngroupShapes (KimonoCore.KimonoShapeGroup)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Ungroups the shapes in the parent group.

+ +

ParameterSummary
group

+The parent KimonoShapeGroup.

+

+
DuplicateShapes

+ +

DuplicateShapes ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the shapes in a selection group.

+
DuplicateShapes

+ +

DuplicateShapes (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the shapes in this selection group into the parent sketch.

+ +

ParameterSummary
sketch

+The parent KimonoSketch.

+

+
DuplicateShapes

+ +

DuplicateShapes (KimonoCore.KimonoShapeGroup)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the shapes in this selection group into the parent group.

+ +

ParameterSummary
group

+The parent KimonoShapeGroup.

+

+
DeleteShapes

+ +

DeleteShapes ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the shapes in this selection group.

+
DeleteShapes

+ +

DeleteShapes (KimonoCore.KimonoSketch)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the shapes in this selection group from the parent sketch.

+ +

ParameterSummary
sketch

+The parent KimonoSketch.

+

+
DeleteShapes

+ +

DeleteShapes (KimonoCore.KimonoShapeGroup)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the shapes in this selection group from the parent group.

+ +

ParameterSummary
group

+The parent KimonoShapeGroup.

+

+
ApplyMoveAndScale

+ +

ApplyMoveAndScale ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the move and scale adjustments to all KimonoShapes inside this group.

+
RemovePropertyConnection

+ +

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the property connection.

+ +

ParameterSummary
connection

+The KimonoPropertyConnection to remove.

+

+
RemoveProperty

+ +

RemoveProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes any connection using this property.

+ +

ParameterSummary
property

+The KimonoProperty to remove.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the group of shapes to a path.

+ +

Returns

+ +

The group of shapes as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draw all the KimonoShapes that are part of this group into the given Skia canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
StartEditing

+ +

StartEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Starts editing this group.

+
EndEditing

+ +

EndEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Ends editing this group.

+
PointInBound

+ +

PointInBound (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given point is inside the bounds of this group.

+ +

ParameterSummary
point

+The SKPoint to test for.

+

+ +

Returns

+ +

true, if the point was in bounds, false otherwise.

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds of this group.

+ +

ParameterSummary
point

+The new location as a SKPoint.

+

+
BoundsChanged

+ +

BoundsChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Update the bouds of this group when they have changed from either a move or a drag operation.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
RelinkShape

+ +

RelinkShape (KimonoCore.KimonoShape)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Relinks the shape after a clone operation.

+ +

ParameterSummary
shape

+The KimonoShape to relink.

+

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

A deep clone of this KimonoShapeGroup.

+
ToolDown

+ +

ToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user placing the current KimonoTool down on the group's Design Surface.

+ +

ParameterSummary
point

+The SKPoint where the tool went down on the Design Surface.

+
clicks

+The number of time the user clicked/tapped the tool down on the Design Surface.

+
multiSelect

+If true, the user has started a multi-shape select process.

+

+

+ + +--- + + +## KimonoShapeGroupType + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the type of a `KimonoShapeGroup`. +

FieldsSummary
Selection

+Selection

+ +

Added In API Version 01.00.00

+ +

The group is a current active selection.

+
DragSelect

+DragSelect

+ +

Added In API Version 01.00.00

+ +

The group is a drag to select selection that is underway.

+
Collection

+Collection

+ +

Added In API Version 01.00.00

+ +

The group is a collection of shape that have been grouped together and are treated as a single object in the editor.

+

+ + +--- + + +## KimonoShapeLine + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a line on the design surface. +

MethodsSummary
KimonoShapeLine

+ +

KimonoShapeLine ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeLine class.

+
KimonoShapeLine

+ +

KimonoShapeLine (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeLine class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeLine

+ +

KimonoShapeLine (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeLine class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the line into the given Skia canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone of the KimonoLine.

+

+ + +--- + + +## KimonoShapeOval + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws an oval into the Design Surface. +

MethodsSummary
KimonoShapeOval

+ +

KimonoShapeOval ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeOval class.

+
KimonoShapeOval

+ +

KimonoShapeOval (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeOval class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeOval

+ +

KimonoShapeOval (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeOval class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draw the oval into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoOval.

+

+ + +--- + + +## KimonoShapePolygon + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a multi-sided polygon into the Design Surface. +

PropertiesSummary
NumberOfSides

+ +

NumberOfSides

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the number of sides.

+ +

Return Value

+ +

The number of sides.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+

+ +

MethodsSummary
KimonoShapePolygon

+ +

KimonoShapePolygon ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapePolygon class.

+
KimonoShapePolygon

+ +

KimonoShapePolygon (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapePolygon class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapePolygon

+ +

KimonoShapePolygon (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapePolygon class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
MakeSidePoints

+ +

MakeSidePoints (System.Double, System.Int32, SkiaSharp.SKRect)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Makes the star points.

+ +

ParameterSummary
startTheta

+Start theta.

+
numPoints

+Number points.

+
skip

+Skip.

+
rect

+Rect.

+

+ +

Returns

+ +

The star points.

+ +

Remarks

+ +

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the polygon into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoPloygon.

+

+ + +--- + + +## KimonoShapeRect + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a rectangle into the Design Surface. +

MethodsSummary
KimonoShapeRect

+ +

KimonoShapeRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRect class.

+
KimonoShapeRect

+ +

KimonoShapeRect (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeRect

+ +

KimonoShapeRect (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the rectangle into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoShapeRoundRect + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a rounded rectangle into the Design Surface. +

PropertiesSummary
CornerRadius

+ +

CornerRadius

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the corner radius.

+ +

Return Value

+ +

The corner radius.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+

+ +

MethodsSummary
KimonoShapeRoundRect

+ +

KimonoShapeRoundRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRoundRect class.

+
KimonoShapeRoundRect

+ +

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRoundRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeRoundRect

+ +

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRoundRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
cornerRadius

+Corner radius.

+

+
KimonoShapeRoundRect

+ +

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRoundRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
KimonoShapeRoundRect

+ +

KimonoShapeRoundRect (System.Single, System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeRoundRect class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
cornerRadius

+Corner radius.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the round rectangle into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeRoundRect.

+

+ + +--- + + +## KimonoShapeStar + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a multi-sided star shape into the Design Surface. +

PropertiesSummary
NumberOfPoints

+ +

NumberOfPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the number of points.

+ +

Return Value

+ +

The number of points.

+
SkipPoints

+ +

SkipPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the skip points.

+ +

Return Value

+ +

The skip points.

+
DepthOffset

+ +

DepthOffset

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the depth offset for the individual points.

+ +

Return Value

+ +

The depth offset.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+

+ +

MethodsSummary
KimonoShapeStar

+ +

KimonoShapeStar ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeStar class.

+
KimonoShapeStar

+ +

KimonoShapeStar (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeStar class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeStar

+ +

KimonoShapeStar (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeStar class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
MakeStarPoints

+ +

MakeStarPoints (System.Double, System.Int32, System.Int32, SkiaSharp.SKRect, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Makes the star points.

+ +

ParameterSummary
startTheta

+Start theta.

+
numPoints

+Number points.

+
skip

+Skip.

+
rect

+Rect.

+

+ +

Returns

+ +

The star points.

+ +

Remarks

+ +

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

+
CalculateConcaveRadius

+ +

CalculateConcaveRadius (System.Int32, System.Int32)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Calculates the concave radius.

+ +

ParameterSummary
numPoints

+Number points.

+
skip

+Skip.

+

+ +

Returns

+ +

The concave radius.

+ +

Remarks

+ +

This code adapted from http://csharphelper.com/blog/2014/08/draw-a-star-with-a-given-number-of-points-in-c/ by Rod Stephens.

+
FindIntersection

+ +

FindIntersection (SkiaSharp.SKPoint, SkiaSharp.SKPoint, SkiaSharp.SKPoint, SkiaSharp.SKPoint, System.Boolean@, System.Boolean@, SkiaSharp.SKPoint@, SkiaSharp.SKPoint@, SkiaSharp.SKPoint@)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the intersection.

+ +

ParameterSummary
p1

+P1.

+
p2

+P2.

+
p3

+P3.

+
p4

+P4.

+
lines_intersect

+If set to true lines intersect.

+
segments_intersect

+If set to true segments intersect.

+
intersection

+Intersection.

+
close_p1

+Close p1.

+
close_p2

+Close p2.

+

+ +

Remarks

+ +

This code adapted from http://csharphelper.com/blog/2014/08/determine-where-two-lines-intersect-in-c/ by Rod Stephens.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the star into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToVector

+ +

ToVector ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the star into a vector.

+ +

Returns

+ +

The KimonoShapeVector version of the star.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeStar.

+

+ + +--- + + +## KimonoShapeState + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Holds the current state of a `KimonoShape` while it is being edited by the user. +

FieldsSummary
Unselected

+Unselected

+ +

Added In API Version 01.00.00

+ +

The shape is unselected.

+
Selected

+Selected

+ +

Added In API Version 01.00.00

+ +

The shape is being selected.

+
Editing

+Editing

+ +

Added In API Version 01.00.00

+ +

The shape is in the edit mode and individual control points can be added, deleted, moved or adjusted.

+
Finalizing

+Finalizing

+ +

Added In API Version 01.00.00

+ +

The shape is leaving the edit mode and needs to be completed.

+
Constructing

+Constructing

+ +

Added In API Version 01.00.00

+ +

The shape is in the process of being built. For example, a set of shapes being added to a group.

+
Grouping

+Grouping

+ +

Added In API Version 01.00.00

+ +

The shape is being added to a group.

+

+ + +--- + + +## KimonoShapeText + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a block of text into the Design Surface within the specifid bounds of this shape. +

PropertiesSummary
Text

+ +

Text

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text.

+ +

Return Value

+ +

The text.

+
FontMetrics

+ +

FontMetrics

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the font metrics.

+ +

Return Value

+ +

The font metrics.

+
IsLinearText

+ +

IsLinearText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeText is linear text.

+ +

Return Value

+ +

true if is linear text; otherwise, false.

+
IsVerticalText

+ +

IsVerticalText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeText is vertical text.

+ +

Return Value

+ +

true if is vertical text; otherwise, false.

+
StrikeThruText

+ +

StrikeThruText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeText strike thru text.

+ +

Return Value

+ +

true if strike thru text; otherwise, false.

+
TextAlign

+ +

TextAlign

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text align.

+ +

Return Value

+ +

The text align.

+
TextEncoding

+ +

TextEncoding

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text encoding.

+ +

Return Value

+ +

The text encoding.

+
TextScaleX

+ +

TextScaleX

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text scale x.

+ +

Return Value

+ +

The text scale x.

+
TextSize

+ +

TextSize

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the size of the text.

+ +

Return Value

+ +

The size of the text.

+
TextSkewX

+ +

TextSkewX

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text skew x.

+ +

Return Value

+ +

The text skew x.

+
Typeface

+ +

Typeface

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the typeface.

+ +

Return Value

+ +

The typeface.

+
FontFamilyName

+ +

FontFamilyName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the font family.

+ +

Return Value

+ +

The name of the font family.

+
TypefaceStyle

+ +

TypefaceStyle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the typeface style.

+ +

Return Value

+ +

The typeface style.

+
UnderlineText

+ +

UnderlineText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeText underline text.

+ +

Return Value

+ +

true if underline text; otherwise, false.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoShape.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+

+ +

MethodsSummary
KimonoShapeText

+ +

KimonoShapeText ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeText class.

+
KimonoShapeText

+ +

KimonoShapeText (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeText class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeText

+ +

KimonoShapeText (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeText class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoShape with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the text block into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+ +

Remarks

+ +

TODO: This routine currently breaks line on characters and it needs to be adjust to break on word boundaries.

+
GrowBounds

+ +

GrowBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Grows the bounds of the text block.

+ +

ParameterSummary
point

+The SKPoint to adjust the bounds by.

+

+ +

Remarks

+ +

TODO: Changing the bounds of a text box should optionally scale the size of the text within.

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds of the text block.

+ +

ParameterSummary
point

+The SKPoint with the new location of the bounds.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+ +

Remarks

+ +

TODO: This routine currently breaks line on characters and it needs to be adjust to break on word boundaries.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeText.

+

+ + +--- + + +## KimonoShapeTriangle + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Draws a triangle into the Design Surface. +

MethodsSummary
KimonoShapeTriangle

+ +

KimonoShapeTriangle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeTriangle class.

+
KimonoShapeTriangle

+ +

KimonoShapeTriangle (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeTriangle class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeTriangle

+ +

KimonoShapeTriangle (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeTriangle class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the triangle into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeTriangle.

+

+ + +--- + + +## KimonoShapeVector + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +A vector is a hard edged shape consisting of a set of datapoints that will be drawn into the Desing Surface. +

PropertiesSummary
Points

+ +

Points

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the points that define the shape.

+ +

Return Value

+ +

The points.

+
Closed

+ +

Closed

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoShapeVector is closed.

+ +

Return Value

+ +

true if closed; otherwise, false.

+
IsEditable

+ +

IsEditable

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoShapeVector is editable.

+ +

Return Value

+ +

true if is editable; otherwise, false.

+

+ +

MethodsSummary
KimonoShapeVector

+ +

KimonoShapeVector ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeVector class.

+
KimonoShapeVector

+ +

KimonoShapeVector (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeVector class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoShapeVector

+ +

KimonoShapeVector (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShapeVector class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
RecalculateVectorBounds

+ +

RecalculateVectorBounds ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Recalculates the vector bounds to encompas all of the data points that define the shape.

+
AddPoint

+ +

AddPoint (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a point to the shape.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+

+
AddPoint

+ +

AddPoint (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given point to the shape.

+ +

ParameterSummary
point

+The new SKPoint to add.

+

+
MoveLastPoint

+ +

MoveLastPoint (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the last point added to the new position.

+ +

ParameterSummary
point

+The SKPoint for the new position.

+

+
RemovePoint

+ +

RemovePoint (System.Int32)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the given point.

+ +

ParameterSummary
n

+The index of the point ot remove.

+

+
ApplyMoveAndScale

+ +

ApplyMoveAndScale ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the move and scale amount to the data point that make up the shape.

+
ToPath

+ +

ToPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the current shape to a path.

+ +

Returns

+ +

The shape as a SKPath.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the shape into the given Skia Canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw into.

+

+
PointInBound

+ +

PointInBound (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Tests to see if the given point is inside the bounds of the shape.

+ +

ParameterSummary
point

+The SKPoint to test.

+

+ +

Returns

+ +

true, if in bound was pointed, false otherwise.

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds of the shape to a new location.

+ +

ParameterSummary
point

+The SKPoint to drag the bounds to.

+

+
BoundsChanged

+ +

BoundsChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the bounds of the shape being changed.

+
StartEditing

+ +

StartEditing ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Places the shape into the editing mode where the user can adjust the individual data points that define the shape.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone KimonoShapeVector.

+

+ + +--- + + +## KimonoProperty + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a property that can be attached to another Kimono object (such as a `KimonoColor`, `KimonoStyle` or `KimonoShape`) and be used as a local variable, global variable or a parameter or be the result of a calculation using the Obi Simple Scripting Language. +

PropertiesSummary
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name as a string.

+
Usage

+ +

Usage

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the usage of this property.

+ +

Return Value

+ +

The KimonoPropertyUsage of this KimonoProperty.

+
IsObiScriptValue

+ +

IsObiScriptValue

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoProperty is the result of an Obi Script.

+ +

Return Value

+ +

true if is Obi Script value; otherwise, false.

+
ObiScript

+ +

ObiScript

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the obi script that will be used to calculate the value of this KimonoProperty.

+ +

Return Value

+ +

The obi script.

+

+ +

MethodsSummary
KimonoProperty

+ +

KimonoProperty ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoProperty class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToRect

+ +

ToRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a SKRect.

+ +

Returns

+ +

The SKRect value.

+
ToFloat

+ +

ToFloat ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a float.

+ +

Returns

+ +

The float value.

+
ToInt

+ +

ToInt ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to an int.

+ +

Returns

+ +

The int value.

+
ToStyle

+ +

ToStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoStyle.

+ +

Returns

+ +

The KimonoStyle value.

+
ToBool

+ +

ToBool ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a bool.

+ +

Returns

+ +

The bool value.

+
ToColor

+ +

ToColor ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoColor.

+ +

Returns

+ +

The color.

+
ToGradient

+ +

ToGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoGradient.

+ +

Returns

+ +

The gradient.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyUsage + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines how a `KimonoProperty` is used when it is attached to a `KimonoShape`, `KimonoSketch` or `KimonoPortfolio`. +

FieldsSummary
LocalVariable

+LocalVariable

+ +

Added In API Version 01.00.00

+ +

The given KimonoProperty will be used as a local variable in the generated code for a Kimono object.

+
GlobalVariable

+GlobalVariable

+ +

Added In API Version 01.00.00

+ +

The given KimonoProperty will be used as a global variable in the generated code for a Kimono object.

+
Parameter

+Parameter

+ +

Added In API Version 01.00.00

+ +

The given KimonoProperty will be used as a passed parameter in the generated code for a Kimono object.

+

+ + +--- + + +## KimonoPropertyConnectionPoint + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the point that a `KimonoProperty` value can be connected to another Kimono object such as the `Top` coordinate of a `KimonoShape`. +

FieldsSummary
Undefined

+Undefined

+ +

Added In API Version 01.00.00

+ +

The connection point hasn't been defined.

+
Rect

+Rect

+ +

Added In API Version 01.00.00

+ +

The rectangle that defines the KimonoShape Bounds.

+
Top

+Top

+ +

Added In API Version 01.00.00

+ +

The Top coordinate of a KimonoShape Bounds.

+
Left

+Left

+ +

Added In API Version 01.00.00

+ +

The Left coordinate of a KimonoShape Bounds.

+
Bottom

+Bottom

+ +

Added In API Version 01.00.00

+ +

The Bottom coordinate of a KimonoShape Bounds.

+
Right

+Right

+ +

Added In API Version 01.00.00

+ +

The Right coordinate of a KimonoShape Bounds.

+
Width

+Width

+ +

Added In API Version 01.00.00

+ +

The Widht of a KimonoShape Bounds.

+
Height

+Height

+ +

Added In API Version 01.00.00

+ +

The Height of a KimonoShape Bounds.

+
RotationDegrees

+RotationDegrees

+ +

Added In API Version 01.00.00

+ +

The Rotational Degrees of a KimonoShape Bounds.

+
Style

+Style

+ +

Added In API Version 01.00.00

+ +

The KimonoStyle of a KimonoShape.

+
Visible

+Visible

+ +

Added In API Version 01.00.00

+ +

The visibility of a KimonoShape.

+
HasStartHead

+HasStartHead

+ +

Added In API Version 01.00.00

+ +

The has start head of a KimonoShapeArrow.

+
HasEndHead

+HasEndHead

+ +

Added In API Version 01.00.00

+ +

The has end head of a KimonoShapeArrow.

+
HeadInnerRatio

+HeadInnerRatio

+ +

Added In API Version 01.00.00

+ +

The head inner ratio of a KimonoShapeArrow.

+
HeadOuterRatio

+HeadOuterRatio

+ +

Added In API Version 01.00.00

+ +

The head outer ratio of a KimonoShapeArrow.

+
IsStreamlined

+IsStreamlined

+ +

Added In API Version 01.00.00

+ +

The is streamlined of a KimonoShapeArrow.

+
NumberOfSides

+NumberOfSides

+ +

Added In API Version 01.00.00

+ +

The number of sides of a KimonoShapePolygon.

+
CornerRadius

+CornerRadius

+ +

Added In API Version 01.00.00

+ +

The corner radius of a KimonoShapeRoundRect.

+
NumberOfPoints

+NumberOfPoints

+ +

Added In API Version 01.00.00

+ +

The number of points of a KimonoShapeStar.

+
SkipPoints

+SkipPoints

+ +

Added In API Version 01.00.00

+ +

The skip points of a KimonoShapeStar.

+
DepthOffset

+DepthOffset

+ +

Added In API Version 01.00.00

+ +

The depth offset of a KimonoShapeStar.

+
Text

+Text

+ +

Added In API Version 01.00.00

+ +

The text of a KimonoShapeText.

+
BaseColor

+BaseColor

+ +

Added In API Version 01.00.00

+ +

The base color of a KimonoColor.

+
AdjustsHue

+AdjustsHue

+ +

Added In API Version 01.00.00

+ +

The adjusts hue of a KimonoColor.

+
HueAdjustment

+HueAdjustment

+ +

Added In API Version 01.00.00

+ +

The hue adjustment of a KimonoColor.

+
AdjustsSaturation

+AdjustsSaturation

+ +

Added In API Version 01.00.00

+ +

The adjusts saturation of a KimonoColor.

+
SaturationAdjustment

+SaturationAdjustment

+ +

Added In API Version 01.00.00

+ +

The saturation adjustment of a KimonoColor.

+
AdjustsBrightness

+AdjustsBrightness

+ +

Added In API Version 01.00.00

+ +

The adjusts brightness of a KimonoColor.

+
BrightnessAdjustment

+BrightnessAdjustment

+ +

Added In API Version 01.00.00

+ +

The brightness adjustment of a KimonoColor.

+
AdjustsAlpha

+AdjustsAlpha

+ +

Added In API Version 01.00.00

+ +

The adjusts alpha of a KimonoColor.

+
AlphaAdjustment

+AlphaAdjustment

+ +

Added In API Version 01.00.00

+ +

The alpha adjustment of a KimonoColor.

+
HasFrame

+HasFrame

+ +

Added In API Version 01.00.00

+ +

The has frame of a KimonoStyle.

+
HasFrameBlur

+HasFrameBlur

+ +

Added In API Version 01.00.00

+ +

The has frame blur of a KimonoStyle.

+
FrameHorizontalBlurAmount

+FrameHorizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The frame horizontal blur amount of a KimonoStyle.

+
FrameVerticalBlurAmount

+FrameVerticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The frame vertical blur amount of a KimonoStyle.

+
HasFrameShadow

+HasFrameShadow

+ +

Added In API Version 01.00.00

+ +

The has frame shadow of a KimonoStyle.

+
FrameShadowHorizontalOffset

+FrameShadowHorizontalOffset

+ +

Added In API Version 01.00.00

+ +

The frame horizontal offset of a KimonoStyle.

+
FrameShadowVerticalOffset

+FrameShadowVerticalOffset

+ +

Added In API Version 01.00.00

+ +

The frame vertical offset of a KimonoStyle.

+
FrameShadowHorizontalBlurAmount

+FrameShadowHorizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The frame shadow horizontal blur amount of a `KimonoStyle.

+
FrameShadowVerticalBlurAmount

+FrameShadowVerticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The frame shadow vertical blur amount of a KimonoStyle.

+
FrameShadowLinkedColor

+FrameShadowLinkedColor

+ +

Added In API Version 01.00.00

+ +

The color of the frame shadow linked of a KimonoStyle.

+
HasFill

+HasFill

+ +

Added In API Version 01.00.00

+ +

The has fill of a KimonoStyle.

+
HasFillBlur

+HasFillBlur

+ +

Added In API Version 01.00.00

+ +

The has fill blur of a KimonoStyle.

+
FillHorizontalBlurAmount

+FillHorizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The fill horizontal blur amount of a KimonoStyle.

+
FillVerticalBlurAmount

+FillVerticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The fill vertical blur amount of a KimonoStyle.

+
HasFillShadow

+HasFillShadow

+ +

Added In API Version 01.00.00

+ +

The has fill shadow of a KimonoStyle.

+
FillShadowHorizontalOffset

+FillShadowHorizontalOffset

+ +

Added In API Version 01.00.00

+ +

The fill shadow horizontal offset of a KimonoStyle.

+
FillShadowVerticalOffset

+FillShadowVerticalOffset

+ +

Added In API Version 01.00.00

+ +

The fill shadow vertical offset of a KimonoStyle.

+
FillShadowHorizontalBlurAmount

+FillShadowHorizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The fill shadow horizontal blur amount of a KimonoStyle.

+
FillShadowVerticalBlurAmount

+FillShadowVerticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The fill shadow vertical blur amount of a KimonoStyle.

+
FillShadowLinkedColor

+FillShadowLinkedColor

+ +

Added In API Version 01.00.00

+ +

The color of the fill shadow linked of a KimonoStyle.

+
FrameColor

+FrameColor

+ +

Added In API Version 01.00.00

+ +

The color of the frame of a KimonoStyle.

+
FrameGradient

+FrameGradient

+ +

Added In API Version 01.00.00

+ +

The frame gradient of a KimonoStyle.

+
FillColor

+FillColor

+ +

Added In API Version 01.00.00

+ +

The color of the fill of a KimonoStyle.

+
FillGradient

+FillGradient

+ +

Added In API Version 01.00.00

+ +

The fill gradient of a KimonoStyle.

+
IsVerticalText

+IsVerticalText

+ +

Added In API Version 01.00.00

+ +

The is vertical text of a KimonoStyle.

+
StrikeThruText

+StrikeThruText

+ +

Added In API Version 01.00.00

+ +

The strike thru text of a KimonoStyle.

+
TextScaleX

+TextScaleX

+ +

Added In API Version 01.00.00

+ +

The text scale x of a KimonoStyle.

+
TextSize

+TextSize

+ +

Added In API Version 01.00.00

+ +

The size of the text of a KimonoStyle.

+
TextSkewX

+TextSkewX

+ +

Added In API Version 01.00.00

+ +

The text skew x of a KimonoStyle.

+
FontFamilyName

+FontFamilyName

+ +

Added In API Version 01.00.00

+ +

The name of the font family of a KimonoStyle.

+
UnderlineText

+UnderlineText

+ +

Added In API Version 01.00.00

+ +

The underline text of a KimonoStyle.

+
HasFrameJitter

+HasFrameJitter

+ +

Added In API Version 01.00.00

+ +

The has frame jitter of a KimonoStyle.

+
FrameJitterLength

+FrameJitterLength

+ +

Added In API Version 01.00.00

+ +

The length of the frame jitter of a KimonoStyle.

+
FrameJitterDeviation

+FrameJitterDeviation

+ +

Added In API Version 01.00.00

+ +

The frame jitter deviation of a KimonoStyle.

+
HasFillJitter

+HasFillJitter

+ +

Added In API Version 01.00.00

+ +

The has fill jitter of a KimonoStyle.

+
FillJitterLength

+FillJitterLength

+ +

Added In API Version 01.00.00

+ +

The length of the fill jitter of a KimonoStyle.

+
FillJitterDeviation

+FillJitterDeviation

+ +

Added In API Version 01.00.00

+ +

The fill jitter deviation of a KimonoStyle.

+
HasFrameDash

+HasFrameDash

+ +

Added In API Version 01.00.00

+ +

The has frame dash of a KimonoStyle.

+

+ + +--- + + +## KimonoPropertyConnection + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a connection between a given Kimono Object and a `KimonoProperty`. +

PropertiesSummary
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
ConnectionPoint

+ +

ConnectionPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the point that a given KimonoProperty is connected to another Kimono Object.

+ +

Return Value

+ +

The connection point as a KimonoPropertyConnectionPoint.

+
ConnectedProperty

+ +

ConnectedProperty

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the connected property.

+ +

Return Value

+ +

The connected KimonoProperty.

+

+ +

MethodsSummary
KimonoPropertyConnection

+ +

KimonoPropertyConnection ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyConnection class.

+
KimonoPropertyConnection

+ +

KimonoPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyConnection class.

+ +

ParameterSummary
connectionPoint

+Connection point.

+
property

+Property.

+

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +##ObiScriptResult + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the result of attempting to execute an Obi Script on a `KimonoProperty` +

PropertiesSummary
Successful

+ +

Successful

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether the Obi Script ran successfully.

+ +

Return Value

+ +

true if successful; otherwise, false.

+
ErrorMessage

+ +

ErrorMessage

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the error message if the Obi Script execution failed.

+ +

Return Value

+ +

The error message or "" if the script ran successfully.

+

+ +

MethodsSummary
ObiScriptResult

+ +

ObiScriptResult ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the ObiScriptResult class.

+
ObiScriptResult

+ +

ObiScriptResult (System.Boolean, System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the ObiScriptResult class.

+ +

ParameterSummary
isSuccessful

+If set to true is successful.

+
errorMessage

+Error message.

+

+

+ + +--- + + +## KimonoBezierPoint + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Holds the control and end point for a `KimonoShapeBezier` that define a quad section of the Bezier. +

PropertiesSummary
ControlPoint

+ +

ControlPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the control point.

+ +

Return Value

+ +

The control point.

+
EndPoint

+ +

EndPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the end point.

+ +

Return Value

+ +

The end point.

+

+ +

MethodsSummary
KimonoBezierPoint

+ +

KimonoBezierPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBezierPoint class.

+
KimonoBezierPoint

+ +

KimonoBezierPoint (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBezierPoint class.

+ +

ParameterSummary
controlPoint

+Control point.

+
endPoint

+End point.

+

+
KimonoBezierPoint

+ +

KimonoBezierPoint (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBezierPoint class.

+ +

ParameterSummary
controlX

+Control x.

+
controlY

+Control y.

+
endX

+End x.

+
endY

+End y.

+

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoBounds + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the outter bounding box for a `KimonoShape` and contains the routines required to draw the bounds and the control handles as the user edits and moves the shape. +

FieldsSummary
Rect

+Rect

+ +

Added In API Version 01.00.00

+ +

The base SkRect that holds the internal bounds of the shape.

+
PreviousCenter

+PreviousCenter

+ +

Added In API Version 01.00.00

+ +

Holds the previous center used in scaling operations.

+
PreviousRect

+PreviousRect

+ +

Added In API Version 01.00.00

+ +

Holds the previous rect used in scaling operations.

+

+ +

PropertiesSummary
State

+ +

State

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the current edit state of the KimonoShape.

+ +

Return Value

+ +

The state as a KimonoShapeState.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
Top

+ +

Top

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the top.

+ +

Return Value

+ +

The top coord location.

+
Left

+ +

Left

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the left.

+ +

Return Value

+ +

The left coord location.

+
Bottom

+ +

Bottom

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the bottom.

+ +

Return Value

+ +

The bottom coord location.

+
Right

+ +

Right

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the right.

+ +

Return Value

+ +

The right coord location.

+
Width

+ +

Width

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the width.

+ +

Return Value

+ +

The width of the shape's bounding box.

+
Height

+ +

Height

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the height.

+ +

Return Value

+ +

The height of the shape's bounding box.

+
HorizontalCenter

+ +

HorizontalCenter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the horizontal center.

+ +

Return Value

+ +

The horizontal center.

+
VerticalCenter

+ +

VerticalCenter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the vertical center.

+ +

Return Value

+ +

The vertical center.

+
Center

+ +

Center

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the center.

+ +

Return Value

+ +

The center.

+
RotationDegrees

+ +

RotationDegrees

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the rotation degrees.

+ +

Return Value

+ +

The rotation degrees.

+
TopLeftHandle

+ +

TopLeftHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the top left handle.

+ +

Return Value

+ +

The top left handle.

+
TopHandle

+ +

TopHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the top handle.

+ +

Return Value

+ +

The top handle.

+
TopRightHandle

+ +

TopRightHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the top right handle.

+ +

Return Value

+ +

The top right handle.

+
RightHandle

+ +

RightHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the right handle.

+ +

Return Value

+ +

The right handle.

+
BottomRightHandle

+ +

BottomRightHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the bottom right handle.

+ +

Return Value

+ +

The bottom right handle.

+
BottomHandle

+ +

BottomHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the bottom handle.

+ +

Return Value

+ +

The bottom handle.

+
BottomLeftHandle

+ +

BottomLeftHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the bottom left handle.

+ +

Return Value

+ +

The bottom left handle.

+
LeftHandle

+ +

LeftHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the left handle.

+ +

Return Value

+ +

The left handle.

+
HitOffset

+ +

HitOffset

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the hit offset.

+ +

Return Value

+ +

The hit offset.

+
HitHandle

+ +

HitHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the hit handle.

+ +

Return Value

+ +

The hit handle.

+

+ +

MethodsSummary
KimonoBounds

+ +

KimonoBounds ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBounds class.

+
KimonoBounds

+ +

KimonoBounds (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBounds class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
KimonoBounds

+ +

KimonoBounds (System.Single, System.Single, System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBounds class.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+
state

+State.

+

+
SavePreviousBounds

+ +

SavePreviousBounds ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Saves the previous bounds.

+
ValueBetween

+ +

ValueBetween (System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Checks to see if the given value is between the two given points.

+ +

ParameterSummary
x

+The x coordinate.

+
a

+The alpha component.

+
b

+The blue component.

+

+ +

Returns

+ +

The Boolean.

+
AddHandles

+ +

AddHandles (KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the control handles to the bounds

+
RemoveHandles

+ +

RemoveHandles ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the control handles from the bounds.

+
BoundsChanged

+ +

BoundsChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates the location of the edit handles when the bounds has been relocated or resized.

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the bounding box and its edit handles into the given canvas

+ +

ParameterSummary
canvas

+Canvas.

+

+
Select

+ +

Select ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Puts the KimonoShape into the edit mode and creates the edit handles as required.

+
PlaceUnderConstruction

+ +

PlaceUnderConstruction (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Places the bounds under construction.

+ +

ParameterSummary
needsHandles

+If set to true needs handles.

+

+
StartGrouping

+ +

StartGrouping ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Starts the bounds grouping.

+
Unselect

+ +

Unselect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Unselects the KimonoShape as the current edit target and removes any edit handles.

+
ChangeBounds

+ +

ChangeBounds (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Changes the bounds to match the given values.

+ +

ParameterSummary
left

+Left.

+
top

+Top.

+
right

+Right.

+
bottom

+Bottom.

+

+
GrowBounds

+ +

GrowBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adjusts the size of the bounds.

+ +

ParameterSummary
point

+The new size as a SKPoint.

+

+
MoveBounds

+ +

MoveBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the bounds to the given point.

+ +

ParameterSummary
point

+The new top, left location as a SKPoint.

+

+
DragBounds

+ +

DragBounds (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the bounds.

+ +

ParameterSummary
point

+Point.

+

+
PointInBound

+ +

PointInBound (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given point is inside of the current bounds

+ +

ParameterSummary
point

+Point.

+

+ +

Returns

+ +

true, if in bounds, false otherwise.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoHandle + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines an edit handle that the user manipulates to edit the bounds of a `KimonoShape` or the control points of a Bezier object. +

FieldsSummary
DrawWidth

+DrawWidth

+ +

Added In API Version 01.00.00

+ +

The width of the drag handle.

+
DrawOffset

+DrawOffset

+ +

Added In API Version 01.00.00

+ +

The draw offset of the drag handle.

+

+ +

PropertiesSummary
Index

+ +

Index

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the index.

+ +

Return Value

+ +

The index.

+
HandleType

+ +

HandleType

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the type of the handle.

+ +

Return Value

+ +

The type of the handle as a KimonoHandleType.

+
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
State

+ +

State

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the edit state of the KimonoHandle.

+ +

Return Value

+ +

The state as a KimonoShapeState.

+
X

+ +

X

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the x value.

+ +

Return Value

+ +

The x coord of the handle's top-left location.

+
Y

+ +

Y

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the y value.

+ +

Return Value

+ +

The y coord of the handle's top-left location.

+
Rect

+ +

Rect

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the rect.

+ +

Return Value

+ +

The rect.

+
Constraint

+ +

Constraint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the edit constraint.

+ +

Return Value

+ +

The edit constraint as a KimonoHandleConstraint.

+
HitOffset

+ +

HitOffset

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the hit offset.

+ +

Return Value

+ +

The hit offset.

+
Color

+ +

Color

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color that this handle represents in a gradient. If the LinkedColor property is null, this color will be used.

+ +

Return Value

+ +

The SKColor.

+
LinkedColor

+ +

LinkedColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color that this handle represents in a gradient. If the LinkedColor property is null, the Color property will be used instead.

+ +

Return Value

+ +

The color of the linked.

+
RepresentedColor

+ +

RepresentedColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the color that this handle represents.

+ +

Return Value

+ +

The color as a SKColor.

+

+ +

MethodsSummary
KimonoHandle

+ +

KimonoHandle (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoHandle class.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+

+
KimonoHandle

+ +

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoHandle class.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+
state

+State.

+

+
KimonoHandle

+ +

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoHandleConstraint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoHandle class.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+
constraint

+Constraint.

+

+
KimonoHandle

+ +

KimonoHandle (System.Single, System.Single, KimonoCore.KimonoHandleConstraint, KimonoCore.KimonoShapeState)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoHandle class.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+
constraint

+Constraint.

+
state

+State.

+

+
Draw

+ +

Draw (SkiaSharp.SKCanvas)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the hanled into the given Skia canvas.

+ +

ParameterSummary
canvas

+The SKCanvas to draw the hanled into.

+

+ +

Returns

+ +

The draw.

+
MoveTo

+ +

MoveTo (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Moves the handle to the given coordinates.

+ +

ParameterSummary
x

+The x coordinate.

+
y

+The y coordinate.

+

+
PointInBound

+ +

PointInBound (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Test to see if the given point is inside of the current bounds

+ +

ParameterSummary
point

+Point.

+

+ +

Returns

+ +

true, if in bounds, false otherwise.

+
DragHandle

+ +

DragHandle (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Drags the handle.

+ +

ParameterSummary
point

+Point.

+

+
ToPoint

+ +

ToPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoHandle to a Skia Point.

+ +

Returns

+ +

The SKPoint.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+
RaiseMoved

+ +

RaiseMoved (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the moved event.

+ +

ParameterSummary
point

+Point.

+

+

+ +

EventsSummary
Moved

+ +

Moved

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when moved.

+

+ + +--- + + +## KimonoHandleConstraint + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Constrains the movement of a `KimonoHandle` when it is being moved by the user. +

FieldsSummary
None

+None

+ +

Added In API Version 01.00.00

+ +

No movement constraint.

+
Horizontal

+Horizontal

+ +

Added In API Version 01.00.00

+ +

The handle can only be moved horizontally.

+
Vertical

+Vertical

+ +

Added In API Version 01.00.00

+ +

The handle can only be moved vertically.

+
Locked

+Locked

+ +

Added In API Version 01.00.00

+ +

The handle is locked in place and cannot be moved.

+

+ + +--- + + +## KimonoHandleType + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the type of a `KimonoHandle` that can be used as a general purpose control point to adjust the bounds of a `KimonoShape` or as a point for a vector or bezier object. +

FieldsSummary
ControlPoint

+ControlPoint

+ +

Added In API Version 01.00.00

+ +

A general purpose handle for a shape's bound or a control point on a vector or bezier.

+
GradientColor

+GradientColor

+ +

Added In API Version 01.00.00

+ +

Defines a color inside of a gradient.

+
GradientPosition

+GradientPosition

+ +

Added In API Version 01.00.00

+ +

Defines the position of a gradient in a shape object.

+
BezierControlPoint

+BezierControlPoint

+ +

Added In API Version 01.00.00

+ +

Defines the control point for a KimonoShapeBezier end point used to adjust the curve of a bezier quad section.

+

+ + +--- + + +## KimonoBlur + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a blur effect that can be attached to the fill or the frame of a `KimonoShape`. +

FieldsSummary
_horizontalBlurAmount

+_horizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The horizontal blur amount.

+
_verticalBlurAmount

+_verticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The vertical blur amount.

+

+ +

PropertiesSummary
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
HorizontalBlurAmount

+ +

HorizontalBlurAmount

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the horizontal blur amount.

+ +

Return Value

+ +

The horizontal blur amount.

+
VerticalBlurAmount

+ +

VerticalBlurAmount

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the vertical blur amount.

+ +

Return Value

+ +

The vertical blur amount.

+
BlurFilter

+ +

BlurFilter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the blur filter represented by this blur effect.

+ +

Return Value

+ +

The SKImageFilter for the blur filter.

+

+ +

MethodsSummary
KimonoBlur

+ +

KimonoBlur ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBlur class.

+
KimonoBlur

+ +

KimonoBlur (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoBlur class.

+ +

ParameterSummary
horizontalBlurAmount

+Horizontal blur amount.

+
verticalBlurAmount

+Vertical blur amount.

+

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this blur effect to code using the Skia library.

+ +

Returns

+ +

The blur as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this blur effect to code using the KimonoCore library.

+ +

Returns

+ +

The blur as code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+
RaiseBlurModified

+ +

RaiseBlurModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the blur modified event.

+

+ +

EventsSummary
BlurModified

+ +

BlurModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when the blur is modified.

+

+ + +--- + + +## KimonoShadow + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a shadow effect that can be attached to the fill or the frame of a `KimonoShape`. +

FieldsSummary
_horizontalOffset

+_horizontalOffset

+ +

Added In API Version 01.00.00

+ +

The horizontal offset.

+
_verticalOffset

+_verticalOffset

+ +

Added In API Version 01.00.00

+ +

The vertical offset.

+
_horizontalBlurAmount

+_horizontalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The horizontal blur amount.

+
_verticalBlurAmount

+_verticalBlurAmount

+ +

Added In API Version 01.00.00

+ +

The vertical blur amount.

+
_color

+_color

+ +

Added In API Version 01.00.00

+ +

The color of the shadow.

+
_linkedColor

+_linkedColor

+ +

Added In API Version 01.00.00

+ +

A linked KimonoColor to use as the shadow color.

+

+ +

PropertiesSummary
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
HorizontalOffset

+ +

HorizontalOffset

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the horizontal offset.

+ +

Return Value

+ +

The horizontal offset.

+
VerticalOffset

+ +

VerticalOffset

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the vertical offset.

+ +

Return Value

+ +

The vertical offset.

+
HorizontalBlurAmount

+ +

HorizontalBlurAmount

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the horizontal blur amount.

+ +

Return Value

+ +

The horizontal blur amount.

+
VerticalBlurAmount

+ +

VerticalBlurAmount

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the vertical blur amount.

+ +

Return Value

+ +

The vertical blur amount.

+
Color

+ +

Color

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color of the shadow.

+ +

Return Value

+ +

The color.

+
LinkedColor

+ +

LinkedColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color of the linked.

+ +

Return Value

+ +

The color of the linked.

+
ShadowColor

+ +

ShadowColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the color of the shadow.

+ +

Return Value

+ +

The color of the shadow as a SKColor.

+ +

Remarks

+ +

Returns either the custom color attached to this shadow or a linked color if it is being used.

+
ShadowFilter

+ +

ShadowFilter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the shadoe filter represented by this shadow effect.

+ +

Return Value

+ +

The SKImageFilter for the blur filter.

+

+ +

MethodsSummary
KimonoShadow

+ +

KimonoShadow ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShadow class.

+
KimonoShadow

+ +

KimonoShadow (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoShadow class.

+ +

ParameterSummary
horizontalOffset

+Horizontal offset.

+
horizontalBlurAmount

+Horizontal blur amount.

+
verticalOffset

+Vertical offset.

+
verticalBlurAmount

+Vertical blur amount.

+

+
HandleLinkedColorChanged

+ +

HandleLinkedColorChanged ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the linked color changed.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shadow to C# code using the Skia library.

+ +

Returns

+ +

The shadow as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shadow to C# code using the KimonoCore library.

+ +

Returns

+ +

The shadow as code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+
RaiseShadowModified

+ +

RaiseShadowModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the shadow modified event.

+

+ +

EventsSummary
ShadowModified

+ +

ShadowModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when the shadow is modified.

+

+ + +--- + + +## KimonoGradient + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a gradient as a collection of either `SKColor` or linked `KimonoColors` that can be applied to a `KimonoStyle` and used when drawing a `KimonoShape`. +

FieldsSummary
_gradientType

+_gradientType

+ +

Added In API Version 01.00.00

+ +

The type of the gradient.

+
_startPoint

+_startPoint

+ +

Added In API Version 01.00.00

+ +

The start point.

+
_endPoint

+_endPoint

+ +

Added In API Version 01.00.00

+ +

The end point.

+
_radius

+_radius

+ +

Added In API Version 01.00.00

+ +

The radius for radial and conical gradients.

+
_tileMode

+_tileMode

+ +

Added In API Version 01.00.00

+ +

The gradient tile mode.

+
_selectedHandle

+_selectedHandle

+ +

Added In API Version 01.00.00

+ +

The selected handle.

+
PerformingDrag

+PerformingDrag

+ +

Added In API Version 01.00.00

+ +

Is the user performing a drag operation.

+

+ +

PropertiesSummary
GradientType

+ +

GradientType

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the type of the gradient.

+ +

Return Value

+ +

The type of the gradient.

+
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
ElementName

+ +

ElementName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the element as it will be called in generated source code.

+ +

Return Value

+ +

The name of the element.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
BarWidth

+ +

BarWidth

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the width of the bar.

+ +

Return Value

+ +

The width of the bar.

+
BarHeight

+ +

BarHeight

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the height of the bar.

+ +

Return Value

+ +

The height of the bar.

+
PreviewWidth

+ +

PreviewWidth

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the width of the preview.

+ +

Return Value

+ +

The width of the preview.

+
PreviewHeight

+ +

PreviewHeight

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the height of the preview.

+ +

Return Value

+ +

The height of the preview.

+
StartPoint

+ +

StartPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the start point.

+ +

Return Value

+ +

The start point.

+
EndPoint

+ +

EndPoint

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the end point.

+ +

Return Value

+ +

The end point.

+
Radius

+ +

Radius

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the radius used by radial and conical gradients.

+ +

Return Value

+ +

The radius.

+
TileMode

+ +

TileMode

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the tile mode.

+ +

Return Value

+ +

The tile mode.

+
ControlPoints

+ +

ControlPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the control points that define the color.

+ +

Return Value

+ +

The control points.

+
SelectedHandle

+ +

SelectedHandle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the selected handle.

+ +

Return Value

+ +

The selected handle.

+
SelectedColor

+ +

SelectedColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the color of the selected handle.

+ +

Return Value

+ +

The color of the selected handle or black if no handle is selected.

+
Shader

+ +

Shader

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the Skia Shader that represents this gradient.

+ +

Return Value

+ +

The SKShader for this gradient.

+

+ +

MethodsSummary
KimonoGradient

+ +

KimonoGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoGradient class.

+
KimonoGradient

+ +

KimonoGradient (KimonoCore.KimonoGradientType, KimonoCore.KimonoHandle, KimonoCore.KimonoHandle, System.Single, SkiaSharp.SKShaderTileMode, SkiaSharp.SKColor[], System.Single[])

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoGradient class.

+ +

ParameterSummary
gradientType

+Gradient type.

+
startPoint

+Start point.

+
endPoint

+End point.

+
radius

+Radius.

+
tileMode

+Tile mode.

+
colors

+Colors.

+
weights

+Weights.

+

+
KimonoGradient

+ +

KimonoGradient (System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoGradient class.

+ +

ParameterSummary
barWidth

+Bar width.

+
barHeight

+Bar height.

+

+
KimonoGradient

+ +

KimonoGradient (System.Single, System.Single, System.Single, System.Single)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoGradient class.

+ +

ParameterSummary
barWidth

+Bar width.

+
barHeight

+Bar height.

+
previewWidth

+Preview width.

+
previewHeight

+Preview height.

+

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
SortedColors

+ +

SortedColors ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns a list of sorted colors by their "X" location inside the gradient.

+ +

Returns

+ +

The sorted colors arrays.

+
SortedWeights

+ +

SortedWeights ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns a list a color weights by their "X" location in the gradient.

+ +

Returns

+ +

The sorted weights.

+
ConformingShader

+ +

ConformingShader (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Generates a shader that conforms to a given start and end point.

+ +

ParameterSummary
startPoint

+Start point.

+
endPoint

+End point.

+

+ +

Returns

+ +

The SKShader for the gradient bound to a given shape's dimentions.

+
AddControlPoint

+ +

AddControlPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds a new control point to the gradients collection and makes it the selected control point.

+
DeleteSelectedControlPoint

+ +

DeleteSelectedControlPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Deletes the selected control point.

+
DuplicateSelectedControlPoint

+ +

DuplicateSelectedControlPoint ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Duplicates the selected control point.

+
FindHandle

+ +

FindHandle (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Finds the handle matching the given unique ID.

+ +

ParameterSummary
uniqueID

+Unique identifier.

+

+ +

Returns

+ +

The matching KimonoHandle or null if not found.

+
DrawBar

+ +

DrawBar ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the bar.

+ +

Returns

+ +

The bar.

+
DrawPreview

+ +

DrawPreview ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Draws the preview.

+ +

Returns

+ +

The preview.

+
BarToolDown

+ +

BarToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user clicking a control point in the gradient design bar.

+ +

ParameterSummary
point

+The point the user clicked.

+
clicks

+The number of times the user clicked.

+
multiSelect

+If set to true multi select.

+

+
BarToolDrag

+ +

BarToolDrag (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user draging a control point in the gradient design bar.

+ +

ParameterSummary
point

+The new location.

+

+
BarToolUp

+ +

BarToolUp (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user releasing a control point in the gradient design bar.

+ +

ParameterSummary
point

+Point.

+

+
PreviewToolDown

+ +

PreviewToolDown (SkiaSharp.SKPoint, System.Int32, System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user clicking a control point in the gradient preview.

+ +

ParameterSummary
point

+The point the user clicked.

+
clicks

+The number of times the user clicked.

+
multiSelect

+If set to true multi select.

+

+
PreviewToolDrag

+ +

PreviewToolDrag (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user draging a control point in the gradient preview.

+ +

ParameterSummary
point

+The new location.

+

+
PreviewToolUp

+ +

PreviewToolUp (SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the user releasing a control point in the gradient preview.

+ +

ParameterSummary
point

+Point.

+

+
ToObiScript

+ +

ToObiScript ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to Obi Script represnetation.

+ +

Returns

+ +

The obi script.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ColorsToCode

+ +

ColorsToCode (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this graidents colors to Skia code.

+ +

Returns

+ +

The color list as code.

+
ColorsToInitializer

+ +

ColorsToInitializer (KimonoCore.CodeOutputLibrary, System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this graidents colors to Skia code.

+ +

Returns

+ +

The color list as code.

+
WeightsToSkiaCode

+ +

WeightsToSkiaCode ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this gradients weights to Skia Code.

+ +

Returns

+ +

The weight list as code.

+
WeightsToSkiaInitializer

+ +

WeightsToSkiaInitializer (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this gradients weights to Skia Code.

+ +

Returns

+ +

The weight list as code.

+
ToCSharpSkia

+ +

ToCSharpSkia ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the gradient to C# Skia csource code.

+ +

Returns

+ +

The gradient as code.

+
ToCSharpSkiaInitializer

+ +

ToCSharpSkiaInitializer ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the gradient to C# Skia csource code.

+ +

Returns

+ +

The gradient as code.

+
ToCSharpSkia

+ +

ToCSharpSkia (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the gradient to C# Skia csource code.

+ +

ParameterSummary
startPoint

+The starting SKPoint.

+
endPoint

+The ending SKPoint.

+

+ +

Returns

+ +

The gradient as code.

+
ToCSharpKimonoCore

+ +

ToCSharpKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this gradient to code using the KimonoCore library.

+ +

Returns

+ +

The gradient as code.

+
ToCSharpKimonoCoreInitializer

+ +

ToCSharpKimonoCoreInitializer ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this gradient to code using the KimonoCore library.

+ +

Returns

+ +

The gradient as code.

+
ToCSharpKimonoCore

+ +

ToCSharpKimonoCore (SkiaSharp.SKPoint, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this gradient to code using the KimonoCore library.

+ +

ParameterSummary
startPoint

+The starting SKPoint.

+
endPoint

+The ending SKPoint.

+

+ +

Returns

+ +

The gradient as code.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the object to C# source code for the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The C# source code.

+
ToCSharpInitializer

+ +

ToCSharpInitializer (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the object to C# source code for the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The C# source code.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary, SkiaSharp.SKPoint, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the object to C# source code for the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+
startPoint

+The starting SKPoint.

+
endPoint

+The ending SKPoint.

+

+ +

Returns

+ +

The C# source code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+
RaiseGradientModified

+ +

RaiseGradientModified ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the gradient modified event.

+
RaiseHandleSelected

+ +

RaiseHandleSelected (KimonoCore.KimonoHandle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Raises the handle selected event.

+ +

ParameterSummary
handle

+Handle.

+

+

+ +

EventsSummary
GradientModified

+ +

GradientModified

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when the gradient is modified.

+
HandleSelected

+ +

HandleSelected

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Occurs when a handle is selected.

+

+ + +--- + + +## KimonoGradientType + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Kimono gradient type. +

FieldsSummary
LinearGradient

+LinearGradient

+ +

Added In API Version 01.00.00

+ +

The linear gradient.

+
RadialGradient

+RadialGradient

+ +

Added In API Version 01.00.00

+ +

The radial gradient.

+
SweepGradient

+SweepGradient

+ +

Added In API Version 01.00.00

+ +

The sweep gradient.

+
ConicalGradient

+ConicalGradient

+ +

Added In API Version 01.00.00

+ +

The conical gradient.

+

+ + +--- + + +## KimonoStyle + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines as style that can be applied to a `KimonoShape` to control its appearance. +

FieldsSummary
_frameColor

+_frameColor

+ +

Added In API Version 01.00.00

+ +

Holds a named KimonoColor attached to the style's frame color.

+
_fillColor

+_fillColor

+ +

Added In API Version 01.00.00

+ +

Holds a named KimonoColor attached to the style's fill color.

+
_frameGradient

+_frameGradient

+ +

Added In API Version 01.00.00

+ +

The frame gradient.

+
_fillGradient

+_fillGradient

+ +

Added In API Version 01.00.00

+ +

The fill gradient.

+
_hasFrameJitter

+_hasFrameJitter

+ +

Added In API Version 01.00.00

+ +

If true, the frame uses the jitter effect.

+
_frameJitterLength

+_frameJitterLength

+ +

Added In API Version 01.00.00

+ +

The length of the frame jitter.

+
_frameJitterDeviation

+_frameJitterDeviation

+ +

Added In API Version 01.00.00

+ +

The frame jitter deviation.

+
_hasFillJitter

+_hasFillJitter

+ +

Added In API Version 01.00.00

+ +

If true, the fill uses the jitter effect.

+
_fillJitterLength

+_fillJitterLength

+ +

Added In API Version 01.00.00

+ +

The length of the fill jitter.

+
_fillJitterDeviation

+_fillJitterDeviation

+ +

Added In API Version 01.00.00

+ +

The fill jitter deviation.

+
_hasFrameDash

+_hasFrameDash

+ +

Added In API Version 01.00.00

+ +

If true, the frame has a dash effect.

+
_hasFillBlur

+_hasFillBlur

+ +

Added In API Version 01.00.00

+ +

The has fill blur.

+
_fillBlur

+_fillBlur

+ +

Added In API Version 01.00.00

+ +

The fill blur.

+
_hasFrameBlur

+_hasFrameBlur

+ +

Added In API Version 01.00.00

+ +

The has frame blur.

+
_frameBlur

+_frameBlur

+ +

Added In API Version 01.00.00

+ +

The frame blur.

+
_hasFillShadow

+_hasFillShadow

+ +

Added In API Version 01.00.00

+ +

The has fill shadow.

+
_fillShadow

+_fillShadow

+ +

Added In API Version 01.00.00

+ +

The fill shadow.

+
_hasFrameShadow

+_hasFrameShadow

+ +

Added In API Version 01.00.00

+ +

The has frame shadow.

+
_frameShadow

+_frameShadow

+ +

Added In API Version 01.00.00

+ +

The frame shadow.

+

+ +

PropertiesSummary
UniqueID

+ +

UniqueID

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the unique identifier.

+ +

Return Value

+ +

The unique identifier.

+
ElementName

+ +

ElementName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the element as it will be called in generated source code.

+ +

Return Value

+ +

The name of the element.

+
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name.

+ +

Return Value

+ +

The name.

+
HasFrame

+ +

HasFrame

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has a frame.

+ +

Return Value

+ +

true if has frame; otherwise, false.

+
Frame

+ +

Frame

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the frame paint style.

+ +

Return Value

+ +

The SKPaint style for the frame.

+
HasFrameBlur

+ +

HasFrameBlur

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has frame blur.

+ +

Return Value

+ +

true if has frame blur; otherwise, false.

+
FrameBlur

+ +

FrameBlur

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the frame blur.

+ +

Return Value

+ +

The KimonoBlur applied to the frame.

+
HasFrameShadow

+ +

HasFrameShadow

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has frame shadow.

+ +

Return Value

+ +

true if has frame shadow; otherwise, false.

+
FrameShadow

+ +

FrameShadow

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the frame shadow.

+ +

Return Value

+ +

The frame shadow as a KimonoShadow.

+
HasFillBlur

+ +

HasFillBlur

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has fill blur.

+ +

Return Value

+ +

true if has fill blur; otherwise, false.

+
FillBlur

+ +

FillBlur

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the fill blur.

+ +

Return Value

+ +

The KimonoBlur applied to the fill.

+
HasFillShadow

+ +

HasFillShadow

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has fill shadow.

+ +

Return Value

+ +

true if has fill shadow; otherwise, false.

+
FillShadow

+ +

FillShadow

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the fill shadow.

+ +

Return Value

+ +

The fill shadow.

+
FrameColor

+ +

FrameColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color of the frame as a named Kimono Color.

+ +

Return Value

+ +

The color of the frame.

+
FrameGradient

+ +

FrameGradient

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the frame gradient.

+ +

Return Value

+ +

The frame gradient.

+
HasFill

+ +

HasFill

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle has fill.

+ +

Return Value

+ +

true if has fill; otherwise, false.

+
Fill

+ +

Fill

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the fill paint style.

+ +

Return Value

+ +

The SKPaint style for the fill.

+
FillColor

+ +

FillColor

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the color of the fill as a named Kimono Color.

+ +

Return Value

+ +

The color of the fill.

+
FillGradient

+ +

FillGradient

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the fill gradient.

+ +

Return Value

+ +

The fill gradient.

+
StyleType

+ +

StyleType

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the type of the style.

+ +

Return Value

+ +

The type of the style.

+
FontMetrics

+ +

FontMetrics

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the font metrics.

+ +

Return Value

+ +

The font metrics.

+
IsLinearText

+ +

IsLinearText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle is linear text.

+ +

Return Value

+ +

true if is linear text; otherwise, false.

+
IsVerticalText

+ +

IsVerticalText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle is vertical text.

+ +

Return Value

+ +

true if is vertical text; otherwise, false.

+
StrikeThruText

+ +

StrikeThruText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle strike thru text.

+ +

Return Value

+ +

true if strike thru text; otherwise, false.

+
TextAlign

+ +

TextAlign

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text align.

+ +

Return Value

+ +

The text align.

+
TextEncoding

+ +

TextEncoding

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text encoding.

+ +

Return Value

+ +

The text encoding.

+
TextScaleX

+ +

TextScaleX

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text scale x.

+ +

Return Value

+ +

The text scale x.

+
TextSize

+ +

TextSize

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the size of the text.

+ +

Return Value

+ +

The size of the text.

+
TextSkewX

+ +

TextSkewX

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the text skew x.

+ +

Return Value

+ +

The text skew x.

+
Typeface

+ +

Typeface

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the typeface.

+ +

Return Value

+ +

The typeface.

+
FontFamilyName

+ +

FontFamilyName

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the name of the font family.

+ +

Return Value

+ +

The name of the font family.

+
TypefaceStyle

+ +

TypefaceStyle

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the typeface style.

+ +

Return Value

+ +

The typeface style.

+
UnderlineText

+ +

UnderlineText

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether this KimonoStyle underline text.

+ +

Return Value

+ +

true if underline text; otherwise, false.

+
HasFrameJitter

+ +

HasFrameJitter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether the frame jitter is used.

+ +

Return Value

+ +

true if has frame jitter; otherwise, false.

+
FrameJitterLength

+ +

FrameJitterLength

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the length of the frame jitter.

+ +

Return Value

+ +

The length of the frame jitter.

+
FrameJitterDeviation

+ +

FrameJitterDeviation

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the frame jitter deviation.

+ +

Return Value

+ +

The frame jitter deviation.

+
HasFillJitter

+ +

HasFillJitter

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether the fill jitter is used.

+ +

Return Value

+ +

true if has fill jitter; otherwise, false.

+
FillJitterLength

+ +

FillJitterLength

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the length of the fill jitter.

+ +

Return Value

+ +

The length of the fill jitter.

+
FillJitterDeviation

+ +

FillJitterDeviation

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the fill jitter deviation.

+ +

Return Value

+ +

The fill jitter deviation.

+
HasFrameDash

+ +

HasFrameDash

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets a value indicating whether the frame has a dash.

+ +

Return Value

+ +

true if the frame has a dash; otherwise, false.

+
DashPattern

+ +

DashPattern

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the dash pattern.

+ +

Return Value

+ +

The dash pattern.

+
ConnectionPoints

+ +

ConnectionPoints

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the possible connection points that a KimonoProperty can be connected to this KimonoStyle.

+ +

Return Value

+ +

The array of KimonoPropertyConnectionPoint.

+
PropertyConnections

+ +

PropertyConnections

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the list of KimonoProperty objects connected to the various KimonoPropertyConnectionPoints that will need to be evaulated before drawing this KimonoShape.

+ +

Return Value

+ +

The property connections.

+

+ +

MethodsSummary
ClonePaint

+ +

ClonePaint (SkiaSharp.SKPaint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clones the given SKPaint object.

+ +

ParameterSummary
paint

+The SKPaint object to clone.

+

+ +

Returns

+ +

The new SKPaint instance.

+
KimonoStyle

+ +

KimonoStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoStyle class.

+
Initialize

+ +

Initialize ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initialize this instance.

+
HandleFrameBlurOrShadowChange

+ +

HandleFrameBlurOrShadowChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the frame blur change.

+
HandleFillBlurOrShadowChange

+ +

HandleFillBlurOrShadowChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the fill blur change.

+
HandleFrameColorChange

+ +

HandleFrameColorChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the frame color change.

+
HandleFillColorChange

+ +

HandleFillColorChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the fill color change.

+
HandleFrameGradientChange

+ +

HandleFrameGradientChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the frame gradient change.

+
HandleFillGradientChange

+ +

HandleFillGradientChange ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Handles the fill gradient change.

+
MakeDashInterval

+ +

MakeDashInterval ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Makes the dash interval from the dash pattern.

+ +

Returns

+ +

The dash interval.

+
AddPropertyConnection

+ +

AddPropertyConnection (KimonoCore.KimonoPropertyConnectionPoint, KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Connects the given KimonoProperty to the given KimonoPropertyConnectionPoint on this KimonoStyle.

+ +

ParameterSummary
connectionPoint

+The KimonoPropertyConnectionPoint to connect to.

+
property

+The KimonoProperty to connect.

+

+
RemovePropertyConnection

+ +

RemovePropertyConnection (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes the property connection.

+ +

ParameterSummary
connection

+The KimonoPropertyConnection to remove.

+

+
RemoveProperty

+ +

RemoveProperty (KimonoCore.KimonoProperty)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Removes any connection using this property.

+ +

ParameterSummary
property

+The KimonoProperty to remove.

+

+
EvaluateConnectedProperties

+ +

EvaluateConnectedProperties ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluates all of the KimonoProperty objects attached to this KimonoStyle by executling their Obi Scripts and updating the values with the results.

+
UpdatePropertyConnectionPoint

+ +

UpdatePropertyConnectionPoint (KimonoCore.KimonoPropertyConnection)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Updates a KimonoPropertyConnectionPoint on this KimonoStyle with the results of a Obi Script run on an attached KimonoProperty.

+ +

ParameterSummary
connection

+Connection.

+

+
ApplyFrameEffects

+ +

ApplyFrameEffects ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the frame effects based on the style settings.

+
ApplyFillEffects

+ +

ApplyFillEffects ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Applies the fill effects based on the style settings.

+
ToObiScript

+ +

ToObiScript ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to Obi Script represnetation.

+ +

Returns

+ +

The obi script.

+
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
FillToSkiaCode

+ +

FillToSkiaCode ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style's Fill to C# code using the Skia library.

+ +

Returns

+ +

The Fill SKPaint as code.

+
FillToSkiaInitializer

+ +

FillToSkiaInitializer (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style's Fill to C# code using the Skia library.

+ +

Returns

+ +

The Fill SKPaint as code.

+
FrameToSkiaCode

+ +

FrameToSkiaCode ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style's Frame to C# code using the Skia library.

+ +

Returns

+ +

The Frame SKPaint as code.

+
FrameToSkiaInitializer

+ +

FrameToSkiaInitializer (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style's Frame to C# code using the Skia library.

+ +

Returns

+ +

The Frame SKPaint as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style to C# code using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToKimonoCoreInitializer

+ +

ToKimonoCoreInitializer (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this style to C# code using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this styl to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to generate code in.

+

+ +

Returns

+ +

The style as code.

+
ToCSharpInitializer

+ +

ToCSharpInitializer (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this styl to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to generate code in.

+

+ +

Returns

+ +

The style as code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+
Clone

+ +

Clone (System.Boolean)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clones the KimonoStyle.

+ +

ParameterSummary
deepClone

+If set to true, a deep clone of the style is made.

+

+ +

Returns

+ +

The a clone of the KimonoStyle.

+

+ + +--- + + +## KimonoStyleType + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the type of a `KimonoStyle` that will be used to draw a given `KimonoShape` in. +

FieldsSummary
Default

+Default

+ +

Added In API Version 01.00.00

+ +

The default style for new shapes. This style cannot be deleted or renamed by the user.

+
Custom

+Custom

+ +

Added In API Version 01.00.00

+ +

A custom style that belongs only to an individual shape instance.

+
CustomText

+CustomText

+ +

Added In API Version 01.00.00

+ +

A custom text style that belongs only to an individual KimonoShapeText instance.

+
Standard

+Standard

+ +

Added In API Version 01.00.00

+ +

A shared style that can be applied to multiple Kimonoshape instances.

+
Text

+Text

+ +

Added In API Version 01.00.00

+ +

A shared text style that can be applied to multiple KimonoShapeText instances.

+

+ + +--- + + +## KimonoPropertyRect + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `SKRect`. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The value as a SKRect.

+

+ +

MethodsSummary
KimonoPropertyRect

+ +

KimonoPropertyRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyRect class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToRect

+ +

ToRect ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a SKRect.

+ +

Returns

+ +

The SKRect value.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyNumber + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `float` or `int` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The float value.

+

+ +

MethodsSummary
KimonoPropertyNumber

+ +

KimonoPropertyNumber ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyNumber class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToFloat

+ +

ToFloat ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a float.

+ +

Returns

+ +

The float value.

+
ToInt

+ +

ToInt ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to an int.

+ +

Returns

+ +

The int value.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyStyle + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `KimonoStyle` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The KimonoStyle value.

+
IsObiScriptValue

+ +

IsObiScriptValue

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoPropertyColor is obi script value.

+ +

Return Value

+ +

true if is obi script value; otherwise, false.

+

+ +

MethodsSummary
KimonoPropertyStyle

+ +

KimonoPropertyStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyStyle class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToStyle

+ +

ToStyle ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoStyle.

+ +

Returns

+ +

The KimonoStyle value.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyBoolean + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `bool` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The bool value.

+

+ +

MethodsSummary
KimonoPropertyBoolean

+ +

KimonoPropertyBoolean ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyBoolean class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToBool

+ +

ToBool ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a bool.

+ +

Returns

+ +

true, if bool was toed, false otherwise.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyText + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `string` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The value.

+

+ +

MethodsSummary
KimonoPropertyText

+ +

KimonoPropertyText ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyText class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToString

+ +

ToString ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a string.

+ +

Returns

+ +

The string value.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyColor + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `KimonoColor` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The KimonoColor value.

+
IsObiScriptValue

+ +

IsObiScriptValue

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoPropertyColor is obi script value.

+ +

Return Value

+ +

true if is obi script value; otherwise, false.

+

+ +

MethodsSummary
KimonoPropertyColor

+ +

KimonoPropertyColor ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyText class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToColor

+ +

ToColor ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoColor.

+ +

Returns

+ +

The color.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## KimonoPropertyGradient + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines a `KimonoProperty` that represents a `KimonoGradient` value. +

PropertiesSummary
Value

+ +

Value

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets or sets the value.

+ +

Return Value

+ +

The KimonoGradient value.

+
IsObiScriptValue

+ +

IsObiScriptValue

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets a value indicating whether this KimonoPropertyColor is obi script value.

+ +

Return Value

+ +

true if is obi script value; otherwise, false.

+

+ +

MethodsSummary
KimonoPropertyGradient

+ +

KimonoPropertyGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Initializes a new instance of the KimonoPropertyText class.

+
Evaluate

+ +

Evaluate ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Evaluate this instance by executing any attached Obi Script to get the new value for the KimonoProperty.

+ +

Returns

+ +

The result of the Obi Script execution as a ObiScriptResult.

+
ToGradient

+ +

ToGradient ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this KimonoProperty to a KimonoGradient.

+ +

Returns

+ +

The gradient.

+
Clone

+ +

Clone ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Clone this instance.

+ +

Returns

+ +

The clone.

+

+ + +--- + + +## CodeOutputOS + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the OS that code will be generated for +

FieldsSummary
Windows

+Windows

+ +

Added In API Version 01.00.00

+ +

For Windows OS based machines.

+
WindowsUWP

+WindowsUWP

+ +

Added In API Version 01.00.00

+ +

For Windows OS based machines using Universal Windows Platform.

+
WindowsWPF

+WindowsWPF

+ +

Added In API Version 01.00.00

+ +

For Windows OS based machines using Windows Presentation Foundation.

+
Android

+Android

+ +

Added In API Version 01.00.00

+ +

For Android OS based machines.

+
iOS

+iOS

+ +

Added In API Version 01.00.00

+ +

For iOS based machines.

+
tvOS

+tvOS

+ +

Added In API Version 01.00.00

+ +

For tvOS based machines.

+
macOS

+macOS

+ +

Added In API Version 01.00.00

+ +

For macOS based machines.

+
CrossPlatform

+CrossPlatform

+ +

Added In API Version 01.00.00

+ +

Cross-platform code.

+

+ + +--- + + +## CodeOutputLanguage + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Defines the language that code will be output in. +

FieldsSummary
CSharp

+CSharp

+ +

Added In API Version 01.00.00

+ +

Generate code for C#.

+
ObiScript

+ObiScript

+ +

Added In API Version 01.00.00

+ +

Generate code for the internal ObiScript scripting language.

+

+ + +--- + + +## CodeOutputLibrary + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Code output library. +

FieldsSummary
SkiaSharp

+SkiaSharp

+ +

Added In API Version 01.00.00

+ +

Output pure SkiaSharp code.

+
KimonoCore

+KimonoCore

+ +

Added In API Version 01.00.00

+ +

Output code using the helper KimonoCore classes.

+

+ + +--- + + +## KimonoCodeGenerator + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +The Kimono Code Generator has routine to assist in the generation of output source code. +

FieldsSummary
NextElementNumber

+NextElementNumber

+ +

Added In API Version 01.00.00

+ +

The next element number.

+
AddNumberToElementNames

+AddNumberToElementNames

+ +

Added In API Version 01.00.00

+ +

Add number to element names when generating.

+
SupportingColors

+SupportingColors

+ +

Added In API Version 01.00.00

+ +

A list of supporting colors that are required for the object being converted to source code.

+
SupportingGradients

+SupportingGradients

+ +

Added In API Version 01.00.00

+ +

A list of supporting gradients that are required for the object being converted to source code.

+
SupportingStyles

+SupportingStyles

+ +

Added In API Version 01.00.00

+ +

A list of supporting styles that are required for the object being converted to source code.

+

+ +

MethodsSummary
ResetCodeGeneration

+ +

ResetCodeGeneration ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Resets the code generation.

+
AddSupportingColor

+ +

AddSupportingColor (KimonoCore.KimonoColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given color to the collection of named colors that are used in the generation of other Kimono Objects. If a color is already in the collection, its ElementName is returned.

+ +

ParameterSummary
color

+The KimonoColor to add to the collection.

+

+ +

Returns

+ +

The ElementName for the supporting color.

+
CodeForSupportingColors

+ +

CodeForSupportingColors (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting colors used in generating a higher level Kimono object.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoColors.

+
PropertyForSupportingColors

+ +

PropertyForSupportingColors (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoColors.

+
AddSupportingGradient

+ +

AddSupportingGradient (KimonoCore.KimonoGradient)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given gradient to the collection of named gradients that are used in the generation of other Kimono Objects. If a gradient is already in the collection, its ElementName is returned.

+ +

ParameterSummary
gradient

+The KimonoGradient to add.

+

+ +

Returns

+ +

The ElementName for the supporting gradient.

+
CodeForSupportGradients

+ +

CodeForSupportGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting gradients used in generating a higher level Kimono object.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoGradients.

+
PrivateVariablesForSupportingGradients

+ +

PrivateVariablesForSupportingGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoColors.

+
PropertyForSupportingGradients

+ +

PropertyForSupportingGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoColors.

+
InitializerForSupportGradients

+ +

InitializerForSupportGradients (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting gradients used in generating a higher level Kimono object.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoGradients.

+
AddSupportingStyle

+ +

AddSupportingStyle (KimonoCore.KimonoStyle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Adds the given style to the collection of named styles that are used in the generation of other Kimono Objects. If a style is already in the collection, its ElementName is returned.

+ +

ParameterSummary
style

+The KimonoStyle to add.

+

+ +

Returns

+ +

The ElementName for the supporting style.

+
CodeForSupportStyles

+ +

CodeForSupportStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting styles used in generating a higher level Kimono object.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoGradients.

+
PropertyForSupportingStyles

+ +

PropertyForSupportingStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting colors used in generating a higher level Kimono object as a public computed propert.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoColors.

+
InitializerForSupportStyles

+ +

InitializerForSupportStyles (KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Returns the source code for all of the supporting styles used in generating a higher level Kimono object.

+ +

ParameterSummary
outputLanguage

+The CodeOutputLanguage for the generated code.

+
outputLibrary

+The CodeOutputLibrary of the generated code.

+

+ +

Returns

+ +

The source code for the supporting KimonoGradients.

+
MakeElementName

+ +

MakeElementName (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Makes a valid source code name for the name of a given Kimono Object.

+ +

ParameterSummary
name

+The source Kimono Object name.

+

+ +

Returns

+ +

The element name valid for use in source code.

+
IncreaseIndentLevel

+ +

IncreaseIndentLevel (System.String, System.Int32)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Increases the indent level of the given section of source code by the given number of levels

+ +

ParameterSummary
sourceCode

+Source code.

+
levels

+Levels.

+

+ +

Returns

+ +

The indent level.

+
IncreaseIndentLevel

+ +

IncreaseIndentLevel (System.String)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Increases the indent level of the given section of source code.

+ +

ParameterSummary
sourceCode

+The source code to indent.

+

+ +

Returns

+ +

The source code indented by one tab.

+
ColorToCode

+ +

ColorToCode (KimonoCore.CodeOutputLibrary, SkiaSharp.SKColor)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the given color to code using the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to encode to.

+
color

+The SKColor to create code for.

+

+ +

Returns

+ +

The color as code.

+
PointToCode

+ +

PointToCode (KimonoCore.CodeOutputLibrary, SkiaSharp.SKPoint)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the given point to code using the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to encode to.

+
point

+The SKPoint to encode.

+

+ +

Returns

+ +

The point as code.

+
PointToCode

+ +

PointToCode (KimonoCore.CodeOutputLibrary, KimonoCore.KimonoHandle)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the given point to code using the given library.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to encode to.

+
point

+The KimonoHandle to encode.

+

+ +

Returns

+ +

The point as code.

+

+ + +--- + + +##IKimonoCodeGeneration + +### Namespace + +[KimonoCore](#8f9b0d76-5653-4ad0-96b3-560f4444b75f) + +### Added In API Version + +01.00.00 + +### Summary + +Interface for any Kimono Object that support source code generation. +

PropertiesSummary
Name

+ +

Name

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Gets the name.

+ +

Return Value

+ +

The name of the element.

+

+ +

MethodsSummary
ToSkiaSharpPath

+ +

ToSkiaSharpPath ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shapes path to C# Skia based code.

+ +

Returns

+ +

The path as code.

+
ToSkiaSharp

+ +

ToSkiaSharp ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts the shape to C# code using the Skia library.

+ +

Returns

+ +

The shape as code.

+
ToKimonoCore

+ +

ToKimonoCore ()

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape C# using the KimonoCore library.

+ +

Returns

+ +

The kimono core.

+
ToCSharp

+ +

ToCSharp (KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this shape to C# code.

+ +

ParameterSummary
outputLibrary

+The CodeOutputLibrary to use.

+

+ +

Returns

+ +

The shape as C# code.

+
ToCode

+ +

ToCode (KimonoCore.CodeOutputOS, KimonoCore.CodeOutputLanguage, KimonoCore.CodeOutputLibrary)

+ +

Added In API Version

+ +

01.00.00

+ +

Summary

+ +

Converts this object to source code for the given OS, Language and Library.

+ +

ParameterSummary
outputOS

+The CodeOutputOS.

+
outputLanguage

+The CodeOutputLanguage.

+
outputLibrary

+The CodeOutputLibrary.

+

+ +

Returns

+ +

The object represented as source code in a string.

+

+