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 name | Meaning |
---|---|
catalogfilename | A filename (without path and without extension) of a catalog that contains the object to place. |
keyref | Key reference of the object to place |
handingtype | Handing (opening direction) for the object. |
posz | Altitude (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_under | Pass 0 for "On", or 1 for "Under". |
distleftwall | Distance from the left bound of the object to the left end of its adjacent wall. |
distrightwall | Distance from the right bound of the object to the right end of its adjacent wall. |
dimx | Width of the object. |
dimy | Depth of the object |
dimz | Height of the object. |
posetype | A 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 |