KitchenDraw SDK 2
Show / Hide Table of Contents

Method PlaceObjectFromUrl

PlaceObjectFromUrl(string)

Places in the scene an item described by an url, which is typically found in a web catalog for KitchenDraw.

Declaration
public Scene.Object PlaceObjectFromUrl(string webCatalogUrl)
Parameters
Type Name Description
string webCatalogUrl

An url containing the parameters defining an item from a catalog.

Returns
Type Description
Scene.Object

The placed object.

Remarks

A web catalog url typically looks like http://some.site/something?catalogfilename=CATNAME&keyref=KREF1&on_or_under=0&posz=100&posetype=2. The following parameters are read from the URL by KitchenDraw:

Parameter nameMeaning
catalogfilenameA filename (without path and without extension) of a catalog that contains the object to place.
keyrefKey reference of the object to place
handingtypeHanding (opening direction) for the object.
poszAltitude (Z axis position) of the object. The treatment of this parameter depends on on_or_under (described next). For "On", the altitude defines the Z position of the bottom edge of the object, for "Under" - of the top edge.
on_or_underPass 0 for "On", or 1 for "Under".
distleftwallDistance from the left bound of the object to the left end of its adjacent wall.
distrightwallDistance from the right bound of the object to the right end of its adjacent wall.
dimxWidth of the object.
dimyDepth of the object
dimzHeight of the object.
posetypeA type of placement operation. Use 0 to place the object in the scene normally, 1 to set the newly placed object as a hosted object of currently active object in the scene. Pass 2 to replace the currently active object in the scene with the placed object.
script
In this article
Back to top Generated by DocFX