rs2.modeler.properties.restraints.Restraints module#

class rs2.modeler.properties.restraints.Restraints.Restraints(client: Client, ID)#

Bases: ProxyObject

setResetAllDisplacementsByIndices(resetDisplacementsAfterStages: bool, stageIndices: list[int])#
Enable or disable reset all displacements and define stage indices.
setResetAllDisplacementsByNames(resetDisplacementsAfterStages: bool, stageNames: list[str])#
Enable or disable reset all displacements and define stage names.
getResetAllDisplacementsByIndices() tuple[bool, list[int]]#
Returns whether reset all displacements is enabled and the stage index list (1-based).
getResetAllDisplacementsByNames() tuple[bool, list[str]]#
Returns whether reset all displacements is enabled and the stage name list.
setAutoRestraints(autoRestraintType: AutoRestraintsType)#
Applies one of the automatic boundary restraint modes.