Options
All
  • Public
  • Public/Protected
  • All
Menu

A snap point connected to an object

Hierarchy

  • SnapPoint

Index

Methods

getGlobalPosition

getIndex

  • getIndex(): number
  • Return the index of the snap point in the list of snap points for the object (as defined in the editor)

    Returns number

getLocalPosition

  • Get the position of the snap point relative to its parent object

    Returns Vector

getParentObject

getRange

  • getRange(): number
  • Return the snapping range of the snap point

    Returns number

getSnapRotation

  • getSnapRotation(): number
  • Return the relative rotation around the Z axis to which the snap point snaps (if rotation snapping is active)

    Returns number

isValid

  • isValid(): boolean
  • Return whether the object is valid. A snap point becomes invalid after the object it belongs to has been destroyed

    Returns boolean

snapsRotation

  • snapsRotation(): boolean
  • Return whether the snap point also snaps rotation

    Returns boolean