ReinforcementShapeBuilder
    
    Canonical path: NemAll_Python_Reinforcement.ReinforcementShapeBuilder
  
Implementation of the reinforcement shape builder
Methods:
- 
            
AddPoint–Overloaded function. See individual overloads.
 - 
            
AddPoints–Add the shape geometry points
 - 
            
AddSide–Overloaded function. See individual overloads.
 - 
            
AddSides–Add the geometry sides of a shape
 - 
            
CreateShape–Overloaded function. See individual overloads.
 - 
            
CreateStirrup–Overloaded function. See individual overloads.
 - 
            
GetMeshData–Get the mesh data
 - 
            
SetAnchorageHookEnd–Set an anchorage hook at the end of the shape
 - 
            
SetAnchorageHookEndFromSide–Set an anchorage hook at the end of the shape, get the angle from the side
 - 
            
SetAnchorageHookStart–Set an anchorage hook at the start of the shape
 - 
            
SetAnchorageHookStartFromSide–Set an anchorage hook at the start of the shape, get the angle from the side
 - 
            
SetAnchorageLengthEnd–Set the anchorage length at the end of the shape
 - 
            
SetAnchorageLengthStart–Set the anchorage length at the start of the shape
 - 
            
SetConcreteCoverEnd–Set the concrete cover at the end of the shape
 - 
            
SetConcreteCoverLineEnd–Overloaded function. See individual overloads.
 - 
            
SetConcreteCoverLineStart–Overloaded function. See individual overloads.
 - 
            
SetConcreteCoverStart–Set the concrete cover at the start of the shape
 - 
            
SetFullCircleOverlap–Set the overlap length for the full circle stirrup
 - 
            
SetHookEnd–Set the hook at the end of the shape
 - 
            
SetHookStart–Set the hook at the start of the shape
 - 
            
SetOverlapLengthEnd–Set an overlap length a the end of the shape
 - 
            
SetOverlapLengthStart–Set an overlap length a the start of the shape
 - 
            
SetSideLengthEnd–Set the side length at the end of the shape
 - 
            
SetSideLengthStart–Set the side length at the start of the shape
 - 
            
SetStartPoint–Overloaded function. See individual overloads.
 - 
            
__init__–Overloaded function. See individual overloads.
 
            AddPoint
    
  
      overloaded
  
    AddPoint(
    pnt: Point2D,
    concreteCover: float,
    bendingRoller: float,
    zCoordBar: float = 0,
)
Add an end point of a geometry side
Parameters:
- 
            
pnt(Point2D) –End point of the side
 - 
            
concreteCover(float) –Concrete cover
 - 
            
bendingRoller(float) –Bending roller
 - 
            
zCoordBar(float, default:0) –Bar coordinate in z direction of the local shape coordinate system
 
AddPoint(pnt: Point3D, concreteCover: float, bendingRoller: float)
Add an end point of a geometry side
Parameters:
- 
            
pnt(Point3D) –End point of the side
 - 
            
concreteCover(float) –Concrete cover
 - 
            
bendingRoller(float) –Bending roller
 
            AddPoints
    Add the shape geometry points
Parameters:
- 
            
pointList(object) –Point list
 
            AddSide
    
  
      overloaded
  
    AddSide(
    startPnt: Point2D,
    endPnt: Point2D,
    concreteCover: float,
    bendingRoller: float,
    zCoordBar: float = 0,
)
Add a geometry side of the shape
Parameters:
- 
            
startPnt(Point2D) –Start point of the geometry side
 - 
            
endPnt(Point2D) –End point of the geometry side
 - 
            
concreteCover(float) –Concrete cover
 - 
            
bendingRoller(float) –Bending roller between the last and current side
 - 
            
zCoordBar(float, default:0) –Bar coordinate in z direction of the local shape coordinate system
 
            AddSides
    Add the geometry sides of a shape
Parameters:
- 
            
sideList(object) –Side list
 
            CreateShape
    
  
      overloaded
  
    CreateShape(
    diameter: float,
    bendingRoller: float,
    steelGrade: int,
    concreteGrade: int,
    bendingShapeType: BendingShapeType,
) -> BendingShape
Create the shape
Parameters:
- 
            
diameter(float) –Diameter
 - 
            
bendingRoller(float) –Default bending roller
 - 
            
steelGrade(int) –Steel grade
 - 
            
concreteGrade(int) –Concrete grade (index of the global list starting from 0, -1 = use global value from the Allplan settings)
 - 
            
bendingShapeType(BendingShapeType) –Bending shape type
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
CreateShape(
    meshType: str,
    meshBendingDirection: MeshBendingDirection,
    bendingRoller: float,
    steelGrade: int,
    concreteGrade: int,
    bendingShapeType: BendingShapeType,
) -> BendingShape
Create the shape
Parameters:
- 
            
meshType(str) –Mesh type
 - 
            
meshBendingDirection(MeshBendingDirection) –Mesh bending direction
 - 
            
bendingRoller(float) –Default bending roller
 - 
            
steelGrade(int) –Steel grade
 - 
            
concreteGrade(int) –Concrete grade (index of the global list starting from 0, -1 = use global value from the Allplan settings)
 - 
            
bendingShapeType(BendingShapeType) –Bending shape type
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
CreateShape(shapeProps: object) -> BendingShape
Create the shape
Parameters:
- 
            
shapeProps(object) –Shape properties
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
            CreateStirrup
    
  
      overloaded
  
    CreateStirrup(
    diameter: float,
    bendingRoller: float,
    steelGrade: int,
    concreteGrade: int,
    stirrupType: StirrupType,
) -> BendingShape
Create the stirrup shape
Parameters:
- 
            
diameter(float) –Diameter
 - 
            
bendingRoller(float) –Default bending roller
 - 
            
steelGrade(int) –Steel grade
 - 
            
concreteGrade(int) –Concrete grade (index of the global list starting from 0, -1 = use global value from the Allplan settings)
 - 
            
stirrupType(StirrupType) –Type of the stirrup
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
CreateStirrup(
    meshType: str,
    meshBendingDirection: MeshBendingDirection,
    bendingRoller: float,
    steelGrade: int,
    concreteGrade: int,
    stirrupType: StirrupType,
) -> BendingShape
Create the stirrup shape
Parameters:
- 
            
meshType(str) –Mesh type
 - 
            
meshBendingDirection(MeshBendingDirection) –Mesh bending direction
 - 
            
bendingRoller(float) –Default bending roller
 - 
            
steelGrade(int) –Steel grade
 - 
            
concreteGrade(int) –Concrete grade (index of the global list starting from 0, -1 = use global value from the Allplan settings)
 - 
            
stirrupType(StirrupType) –Type of the stirrup
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
CreateStirrup(shapeProps: object, stirrupType: StirrupType) -> BendingShape
Create the stirrup shape
Parameters:
- 
            
shapeProps(object) –Shape properties
 - 
            
stirrupType(StirrupType) –Type of the stirrup
 
Returns:
- 
              
BendingShape–Creation successful: true/false
 
            GetMeshData
  
      staticmethod
  
GetMeshData(meshType: str) -> MeshData
            SetAnchorageHookEnd
    Set an anchorage hook at the end of the shape
Parameters:
- 
            
angle(float) –Hook angle
 
            SetAnchorageHookEndFromSide
    Set an anchorage hook at the end of the shape, get the angle from the side
            SetAnchorageHookStart
    Set an anchorage hook at the start of the shape
Parameters:
- 
            
angle(float) –Hook angle
 
            SetAnchorageHookStartFromSide
    Set an anchorage hook at the start of the shape, get the angle from the side
            SetAnchorageLengthEnd
    Set the anchorage length at the end of the shape
Parameters:
- 
            
anchorageLength(float) –Anchorage length at the end of the shape
 
            SetAnchorageLengthStart
    Set the anchorage length at the start of the shape
Parameters:
- 
            
anchorageLength(float) –Anchorage length at the start of the shape
 
            SetConcreteCoverEnd
    Set the concrete cover at the end of the shape
Parameters:
- 
            
concreteCover(float) –Concrete cover
 
            SetConcreteCoverLineEnd
    
  
      overloaded
  
    
            SetConcreteCoverLineStart
    
  
      overloaded
  
    
            SetConcreteCoverStart
    Set the concrete cover at the start of the shape
Parameters:
- 
            
concreteCover(float) –Concrete cover
 
            SetFullCircleOverlap
    Set the overlap length for the full circle stirrup
Parameters:
- 
            
fullCircleOverlap(float) –Overlap length
 
            SetHookEnd
SetHookEnd(length: float, angle: float, type: HookType)
Set the hook at the end of the shape
Parameters:
- 
            
length(float) –Hook length (0 = calculate)
 - 
            
angle(float) –Hook angle
 - 
            
type(HookType) –Hook type
 
            SetHookStart
SetHookStart(length: float, angle: float, type: HookType)
Set the hook at the start of the shape
Parameters:
- 
            
length(float) –Hook length (0 = calculate)
 - 
            
angle(float) –Hook angle
 - 
            
type(HookType) –Hook type
 
            SetSideLengthEnd
    Set the side length at the end of the shape
Parameters:
- 
            
sideLength(float) –Side length
 
            SetSideLengthStart
    Set the side length at the start of the shape
Parameters:
- 
            
sideLength(float) –Side length
 
            __init__
    
  
      overloaded
  
    Initialize
__init__(shapePlaneMatrix: Matrix3D)
Constructor
Parameters:
- 
            
shapePlaneMatrix(Matrix3D) –Matrix of the plane for the real shape calculation
 
__init__(
    shapePlaneMatrix: Matrix3D,
    create3DShape: bool,
    localZCoverFront: float,
    localZCoverBack: float,
)
Constructor
Parameters:
- 
            
shapePlaneMatrix(Matrix3D) –Matrix of the plane for the real shape calculation
 - 
            
create3DShape(bool) –Create a 3D shape
 - 
            
localZCoverFront(float) –Concrete cover in the front of the local z direction of the shape (needed for 3D shape)
 - 
            
localZCoverBack(float) –Concrete cover in the back of the local z direction of the shape (needed for 3D shape)
 
__init__(element: ReinforcementShapeBuilder)