Method GetCatalogOutlinePointsString
GetCatalogOutlinePointsString(string, string, HandingType, double, double, double, double, bool, int, int)
Returns polylines composing the outline of a catalog item.
Declaration
public string GetCatalogOutlinePointsString(string catalogFilename, string articleReference, Scene.Object.HandingType handingType, double dimensionX, double dimensionY, double dimensionZ, double oxyAngle, bool opened, int imageWidth, int imageHeight)Parameters
| Type | Name | Description |
|---|---|---|
| string | catalogFilename | Filename of the catalog which contains the item. |
| string | articleReference | The article reference of the item. |
| Scene.Object.HandingType | handingType | Handing of the item. |
| double | dimensionX | Width of the item, in the catalog measurement units. It can be different from the default value set in the catalog. |
| double | dimensionY | Depth of the item, in the catalog measurement units. It can be different from the default value set in the catalog. |
| double | dimensionZ | Height of the item. It can be different from the default value set in the catalog, in the catalog measurement units. |
| double | oxyAngle | Rotation angle applied to the item (in degrees). |
| bool | opened | Indicates whether the item should be exported in its open visual state. |
| int | imageWidth | Width of the image for which the outline is returned. |
| int | imageHeight | Height of the image for which the outline is returned. |
Returns
| Type | Description |
|---|---|
| string |
Remarks
The outline is returned as a character string. The segments'
points' coordinates are given in the pixel space which size is
defined by imageWidth and
imageHeight parameters. The points' coordinates
are separated with a coma(,), the points with a
semi-column(;) and the segments with a column(:) as
illustrated in the example below:
p1x1,p1y1,p1z1;...;p1xn,p1yn,p1zn:p2x1,p2y1,p2z1;...;p2xn,p2yn,p2zn,
where pmxn, pmyn and pmzn are the coordinates
of the nth point of the mth segment.
You can use Scene.Selection_.Outline class to parse this string and to get individual segments and points from this list.
The outline corresponds to the current view mode of the scene.