Namespace KD.SDK2

Classes

Appli

Gives access to the application global data: language, menus, catalog files, sites, users, suppliers, plugins.

Represents an information related to a particular plugin function call (e.g. menu item which provoked a plugin call or a supplier for which an order should be generated). Inlike the Appli.CallParamsInfo_, this class relies on the SDK1's Appli.GetCallParamInfoDirect method, and thus can get more specific information under some circumstances, like handling an embebbed plugin event. It requires CallParamBlock parameter passed to the event handler.

Appli.CallParamsInfo_

Represents an information related to a particular plugin function call (e.g. menu item which provoked a plugin call or a supplier for which an order should be generated).

Appli.CatalogFinish

Represents a finish, which is a predefined set of colours, textures, and some other values applied to an object, having its own code and name.

Appli.CatalogFinishType

Represents a finish type, which is a set of available choices for one particular object's characteristic. Examples are front model, carcase colour, worktop colour, etc.

Appli.CatalogSummary

Provides an access to a catalog data without an ability to modify it, thus excluding perfomance overhead needed to convert a catalog to its editable representation.

Appli.CatalogSummary.AppliCat

Appli.CatalogSummary.Article

Appli.CatalogSummary.Block

Appli.CatalogSummary.Family

Appli.CatalogSummary.Model

Appli.CatalogSummary.Section

Appli.Currency

Represents a currency that may be used when calculating estimates, and generating documents (purchase orders, invoices, etc.).

Appli.Document

Represents a pricing document template which is used by the KitchenDraw software to generate pricing documents (e.g. estimates, purchase orders, invoices, etc.).

Appli.Document.Item

Represents an item of a document, which can be considered as a document template part consisting either of Word document file or of another KitchenDraw document.

Appli.MenuItem

Represents an item of a menu in the KitchenDraw application.

Appli.MobiscriptMenuItem

Represents an item of a menu in the KitchenDraw application.

Appli.MobiscriptWindow_

Allows access to data displayed in the MobiScript window.

Appli.Plugin

Represents a plugin that is loaded in KitchenDraw.

Appli.SceneSummary

Instances of this class allow to examine scene information without full loading it into the application context. This reduces perfomance overhead in cases when the only purpose of loading a scene is to get some information from it (e.g. when listing scenes or calculating some statistics based on scene information).

Appli.Site

Represents a site, which stands for one particular point of sale with own address, phone, legal information, etc.

Appli.Supplier

Represents a supplier of articles which are listed in one or more KitchenDraw catalogs.

Appli.Supplier.Catalog

Holds an information about a KitchenDraw catalog attached to a supplier.

Appli.Supplier.Catalog.CoefficientLine

Represents a coefficient line for a supplier catalog.

Appli.User

Represents an account of KitchenDraw user.

Catalog

Provides access to a catalog and its contents in the same way as it does the MobiScript window. Allows reading and writing data in KitchenDraw catalogs programmatically.

Catalog.Dico_

Allows to read and write information into a catalog's dictionary which is used to translate strings contained in the catalog into different languages supported by KitchenDraw UI.

Catalog.Dico_.Entry

An entry represents a string contained in the catalog and defined in the catalog's language, and all its translations to other languages.

Catalog.Table

Represents a table of a catalog (e.g. Sections, Blocks, Articles, etc.).

Catalog.Table.Cluster

Represents a cluster of a catalog table, which can be considered as group of rows of a table belonging to the same higher level entity (e.g. articles of a block, finishes of a family, etc.).

Catalog.Table.Row

Represents a row of a catalog table.

Dico

Allows to read and write information into the DICO.LNG dictionary file which is used to translate the KitchenDraw user interface.

Dico.Entry

Scene

Provides access to the scene and its content (e.g. objects, observer and view points, generics, headings).

Scene.CatalogChangeError

Represents a single error appeared during a catalog change operation (ChangeCatalog(string, string)).

Scene.CatalogChangeResult

Holds errors (if any) of a catalog change operation. May be casted to bool to check whether the operation succeeded or not.

Scene.CoordinateSystem_

Groups functions related to the scene coordinate system management.

Scene.DrawingStyle

Represents a drawing style of a scene view.

Scene.FinishesConfig

Represents finishes config, which is in essence a set of available finish types and one assigned finish assigned to each of them.

Scene.Generic

Represents a finishes configuration, which is inherited by objects of a scene (fully or partially).

Scene.GridSettings

Represents a drawing style of a scene view.

Scene.Heading

Represents a heading, which can be considered as a table of the pricing view that accumulates similar scene objects and generates a sub-total.

Scene.Object

Represents a single object on a scene.

Scene.Object.Finish

Represents a finish, which is a predefined set of colours, textures, and some other values applied to an object, having its own code and name.

Scene.Object.FinishType

Represents a finish type, which is a set of available choices for one particular object's characteristic. Examples are front model, carcase colour, worktop colour, etc.

Scene.Object.FinishesConfig

Represents finishes config, which is in essence a set of available finish types and one assigned finish assigned to each of them.

Scene.Object.Texture

Represents a texture that is set for the object via the "Object|Attributes" dialog.

Scene.Object.Texture.Color

Scene.Object.Texture.Component

Represents a single component of object's texture - either fill component or outline one.

Scene.ObjectGroup

Scene.SceneArtificialLighting

Scene.SceneLighting

Scene.SceneNaturalLighting

Scene.SceneToneMapping

Scene.Selection_

Represents a set of currently selected objects. Can be used to change add/remove objects to selection, to manipulate the selected objects, and to get some additional data about selected objects as a whole.

Scene.Selection_.Outline

Represents a selection's outline, which is in essense a list of segments defined by the edges of the objects contained in the selection.

Scene.Selection_.Outline.Point

Represents an outline point.

Scene.Selection_.Outline.Segment

Represents an outline segment.

Scene.Selection_.PointsList

Scene.Shape

Represents an object's shape, which is in essence a list of points with some additional data provided for each point.

Scene.Shape.Point

Represents a single point of an object's shape.

Scene.UndoStack_

Groups the functionality dedicated to undoing/redoing scene modifications.

Scene.ViewPoint

Represents a viewpoint, which can be considered as persistent set of camera position, direction, and field of view.

Scene.View_

Provides access to the KitchenDraw functionality dedicated to displaying scene to a user.

Sdk2Exception

Represents errors that occur during KitchenDraw SDK execution.

Sdk2ParseException

Represents errors that occur while converting raw value from KitchenDraw SDK into some specific .NET type.

Sdk2SetInfoException

Represents an error that occurs while setting a property value for an SDK class.

Structs

Appli.MenuItemInsertionInfo

HashCode

Scene.Heading.ObjectAndQuantity

Scene.ImmutablePoint

Represents a 3D point defined in the scene coordinate space. Once created, this point can't be edited.

Scene.Object.TransformMatrix

Represents a transformation matrix.

Scene.Object.Vector4

Represents a vector or a point in the terms of matrix algebra (so-called homogenous representation).

Scene.Point

Represents a 3D point defined in the scene coordinate space.

Scene.SpecialTermValue

Represents special term value, which can be expressed ither as a relative value or as an absolute one.

Scene.UndoState

Represents an undo state, which is some kind of a scene snapshot that stores some data. This way a user can undo his action, by reapplying the data from the snapshot in fact.

Scene.View_.Bounds2D

Represents bounds of the non-empty area of the current view.

Scene.View_.MagneticPoint

Scene.View_.MagneticPoint.ProjectedPoint

Represents a 2D projection of a 3D point on the plane of the scene view.

Scene.View_.PixelPoint

Represents 2D point defined in a window pixel space.

Interfaces

Catalog.ITableCollection

Represents all the tables of a catalog.

ICustomInfoDictionary

Provides access to the custom configuration variables that are stored object's custom data area dedicated wholely to the application extensions.

IKeywordInfoDictionary

Provides access to the object data through the special variables that are used for the document generation.

Enums

Appli.CatalogSummary.AppliCat.FetchFields

Represents a field of a model that can be retrieved from a catalog.

Appli.CatalogSummary.Article.FetchFields

Represents a field of an article that can be retrieved from a catalog.

Appli.CatalogSummary.Block.FetchFields

Represents a field of a block that can be retrieved from a catalog.

Appli.CatalogSummary.Family.FetchFields

Represents a field of a family that can be retrieved from a catalog.

Appli.CatalogSummary.LinearArticleType

Represents a type of linear article of a catalog.

Appli.CatalogSummary.Model.FetchFields

Represents a field of a model that can be retrieved from a catalog.

Appli.CatalogSummary.Section.FetchFields

Represents a field of a section that can be retrieved from a catalog.

Appli.Document.ItemLoopType

Represents a repetition type of a document item.

Appli.Document.ItemType

Represents a type of an item of a document.

Appli.DocumentType

Describes a type of pricing document.

Appli.MenuItem.StandardId

Appli.MenuItemInsertionPosition

Appli.MenuKeyCode

Specifies keyboard key codes

Appli.MenuKeyModifiers

Specifies keyboard modifier keys.

Appli.MobiscriptMenuItem.StandardId

Appli.SceneListSortingType

Represents a sorting criteria available for use in the GetScenes(string, bool, string, SceneListSortingType) method.

Appli.Supplier.Catalog.TableType

Represents a type of coefficients table for a supplier catalog.

Appli.UnitType

Appli.User.DiscountPermissionLevel

Describes a level of discount which is permitted to a user.

Catalog.PriceConfigurationType

Represents a price configuration for a catalog, which means price types that can be defined inside catalog tables.

Catalog.TableType

Represents a type of a catalog table. Each catalog has exactly one table of each type.

DimensionConstraint

Describes the dimensions that are constrained for an object and so can't be changed by user.

Scene.CatalogChangeErrorKind

Describes a type of an error that appeared during a catalog change operation (ChangeCatalog(string, string)).

Scene.ComponentType

Represents the type of component that an object can be.

Scene.DimensionLevel

Represents the line on which the dimensions are being placed.

Scene.DimensionType

Represents a type of a scene dimension.

Scene.DimensionViewMode

Indicates the view mode in which the dimensions must be placed.

Scene.DiscountType

Represents types of discounts that can be applied to an object.

Scene.DrawingStyle.OutlineType

Ways to represent outlines in a scene view.

Scene.DrawingStyle.SurfaceType

Ways to represent surfaces in a scene view.

Scene.MarkColor

Represents background color of object's mark - a text displayed above an object on top or elevation view.

Scene.MarkingType

Represents a type of marking of the scene objects.

Scene.Object.AltitudeType

Represents altitude reference of an object.

Scene.Object.DoorSubType

Represents a subtype of a door object.

Scene.Object.EcoMobType

Represents Eco-Mobilier calculation type applied to the object.

Scene.Object.EventType

Represents events that are triggered for the object by the KitchenDraw software.

Scene.Object.HandingType

Represents handing, which may be also considered as the direction of opening, or as hinges position on a firnuture element.

Scene.Object.LinearSubType

Represents a subtype of a linear object.

Scene.Object.PlanArticleSubType

Represents a subtype of a plan article object.

Scene.Object.PlanSubType

Represents a subtype of a plan object.

Scene.Object.WallSubType

Represents a subtype of a wall object.

Scene.ObjectType

Represents all the possible object types in the KitchenDraw software.

Scene.PricingType

Represents pricing types available for an object.

Scene.SnapDirection

Represents the direction of snapping.

Scene.SnapType

Represents the type of snapping relation between objects.

Scene.TextColor

Represents colors that may be applies to a text object contained in a scene.

Scene.UndoStateType

Represents a type of scene data to save in an undo state.

Scene.VatRateType

Represents a VAT rate which may be applied to the scene.

Scene.ViewMode

Represents view modes in which the KitchenDraw software can represent a scene.

Scene.ViewType

Represents view types available in the KitchenDraw software for representing a scene.

SceneArtificialLightDisposition

Lists possible dispositions of artificial light.

SceneArtificialLightType

Describes the type of artificial light in the scene.

SceneNaturalLightingMode

Indicates whether the scene is lighted as an outdoor scene or as an indoor scene.

SceneNaturalLightingWeatherMode

Defines how the direct sun light is calculated for the photorealistic renderings.

SunPositionMode

Lists possible ways to specify position of the sun for a scene.