rs3.ExternalVolume module#
- class rs3.ExternalVolume.ExternalVolume(client: Client, projectID: str)#
Bases:
_ProxyObjectExamples: See External Volume and Selection Script Examples.
- setName(name: str)#
- getName() str#
- setRole(role: ExternalVolumeRoles)#
- getRole() ExternalVolumeRoles#
- setAppliedMaterialProperty(stageNum: int, materialName: str)#
Assign material to the given stage by material name. If the external volume is excavated, “No Material” should be used as the materialName.
- getAppliedMaterialProperty(stageNum: int)#
- setGrouping(stageNum: int, groupName: str)#
Assign group to the given stage by the group name. To ungroup the material, “Ungrouped” should be used as the groupName.
- getGrouping(stageNum: int)#
- getVolume() str#
- getTotalSurfaceArea() str#