rs2.modeler.properties.CompositeProperty module#

class rs2.modeler.properties.CompositeProperty.CompositeProperty(server: Client, ID, documentProxyID)#

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Composite Liner Properties

getCompositeName() → str#

setCompositeName(value: str)#

getCompositeColor() → int#

setCompositeColor(value: int)#

getJointPlacement() → CompositeJointPlacementTypes#

setJointPlacement(value: CompositeJointPlacementTypes)#

getCompositeJointPropertyName() → str#: Returns the applied joint name

setCompositeJointPropertyByName(jointName: str)#: Set joint by name

getCompositeLinerPropertyName(layerNumber: int) → str#: Returns the liner name for specified layer number

setCompositeLinerPropertyByName(layerNumber: int, linerName: str)#: Set liner by name for specified layer number

getNumberOfLayers() → int#: Returns number of layers

setNumberOfLayers(num_layers: int)#: Set number of layers

getJointApplied() → bool#: Returns boolean indicating whether joint interface is applied or not

setJointApplied(joint_applied: bool)#: Set joint interface as boolean

getInstallDelay(layerNumber: int) → int#: Returns install delay as integer for specified layer number

setInstallDelay(layerNumber: int, stagesBelow: int)#: Set install delay for specified layer number. Please note that install delay cannot be set for first layer.

getRemovedStage(layerNumber: int) → int#: Returns removed stages as integer for specified layer number

setRemovedStage(layerNumber: int, stagesBelow: int)#: Set removed stages for specified layer number. To set the removed stages to “Never”, please set stagesBelow to -1