Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

ComposableGeometryProperties

Synopsis

struct ComposableGeometryProperties {
    BItemId itemId;
    boolean enabled;
    Vector3 position;
    Vector3 scale;
    Rotation rotation;
    string geometry;
}

See also: Vector3, Rotation, BItemId

itemId

The ID of the basket item having this set of composable geometry properties. This field is used if and only if the composable geometry properties are part of item properties returned for a view item.

enabled

This optional property controls whether or not the composable geometry item, when used as a set-article part, will be considered or ignored during composition of the set-article geometry.

position

This optional property indicates where the geometry of the composable geometry item is to be positioned when the geometry of the set-article is composed. The default value of this property is x=0, y=0 and z=0.

scale

  • Operation getItemProperties (§getItemProperties) returns this element for composable geometry items with a scalable geometry (only user article items right now). Its absence indicates that the geometry is not scalable.

    Operation setItemProperties (§setItemProperties) ensures that scale.x, scale.y and scale.z are finite (i.e. neither infinite nor NaN). Other than that the operation ignores this element unless the item is a composable geometry item1. Use with a basket main article item causes an error, even if the scaling factor is one in each direction. Thus user article items are the only items that let the client specify scaling factors for the geometry.

    The scaling factors are applied (or are supposed to be applied) to the geometry before it is rotated and translated.

rotation

This optional property indicates the rotation of the geometry of the composable geometry item when the geometry of the set-article is composed. Rotation occurs around the origin of the geometrie’s local coordinate system. The default value of this property indicates no rotation.

geometry

This optional property can be used with user article items to store the URI of an imported or generated geometry.

If the item is a user article item, the item property enabled has been set to true, the item property geometry contains a valid geometry URI, and the user article item is part of a set-article item, then the specified geometry becomes part of the composite geometry of the set-article item.

Supported geometry formats are EOX, GFX, DWG, DXF, OBJ, GEO and 3DS. Import of materials is supported for EOX, GFX, DWG and DXF only.

If the getItemProperties operation returns composable geometry properties, then the value of the geometry element will be either an empty string or an URI with scheme imp or gen.

If the setItemPropertiessetItemProperties operation encounters a non-empty value for the geometries element, the operation fails without modifying any properties if:

  • this value does not adhere to the URI syntax

  • is a relative URI

  • has a scheme other than imp or gen

  • is an URI not known by the current session (i.e. has not been imported imported or generated by the current session)

  • if the item whose properties are to be set does not allow the explicit specification of a composable geometry part.

Footnotes

  1. Basket main article items and user article items are composable geometry items. ↩