Interface AttachPoint

An attachment point for planning support and placement of children. All attributes are mandatory, except for Tags.

Two attachment points match:

  • if Key and Foreign match, if needed with wildcards in the Foreign key,
  • there's at least one matching Tag on both sides, in case at least one has tags,
  • the Types match to each other, such as L - R
  • both of them are enabled
  • the position offset in global space is less than 0.2 [m]
  • the rotation offset in global spase is less than 45 deg

IGXC Compatibility: the Rotation is changed to Quaternion, in IGXC it was Euler-based.

Hierarchy

  • AttachPoint

Properties

enabled foreign key point representation rotation tags? type

Properties

enabled

enabled: boolean

Attribute controls if the point is enabled. If disabled, it should be invisible too.

foreign

foreign: string

Allowed keys of counterpart's points. May contain * and ? characters.

key

key: string

Own key of the point. Should match the counterpart's foreign key.

point

point: Vector

The position of the point, relative to the Product.

representation

representation: "Standard" | "Ghost" | "Ghost2"

The visual representation of the attachment point. "Standard" - semi-transparent sphere/cube. "Ghost" - semi-transparent representation of a product to be placed "Ghost2" - simplified representation of a product to be placed.

rotation

rotation: Quaternion

The orientation of the point, relative to the Product.

Optional tags

tags?: string[]

type

type: AttachPointType

The type of the point

Settings

Member Visibility

Theme

Generated using TypeDoc