Classes
class	RebarCoating
	No documentation available. More...
class	RebarGrade
	No documentation available. More...
class	RebarShapeTemplate
	No documentation available. More...
class	RebarStandard
	No documentation available. More...
class	ReferencePoint
	No documentation available. More...
class	ShapedRebarMaterial
	No documentation available. More...
class	StringVec
	No documentation available. More...

Functions
def	CheckRebarSetupAndWarn
def	CreateRebarFromLayout
def	FitShapedRebarToDowels
def	GetAvailableRebarCoatingNames
def	GetAvailableRebarCoatings
def	GetAvailableRebarGradeNames
def	GetAvailableRebarGrades
def	GetFilteredRebarTemplates
def	GetRebarTemplates
def	GetValidRebarStandardNames
def	GetValidRebarStandards

Variables
	BOTTOM = Rebar.ReferencePoint.BOTTOM
	BOTTOM_LEFT = Rebar.ReferencePoint.BOTTOM_LEFT
	BOTTOM_RIGHT = Rebar.ReferencePoint.BOTTOM_RIGHT
	CENTER = Rebar.ReferencePoint.CENTER
	LEFT = Rebar.ReferencePoint.LEFT
	RIGHT = Rebar.ReferencePoint.RIGHT
	TOP = Rebar.ReferencePoint.TOP
	TOP_LEFT = Rebar.ReferencePoint.TOP_LEFT
	TOP_RIGHT = Rebar.ReferencePoint.TOP_RIGHT

Function Documentation

def Rebar.CheckRebarSetupAndWarn	(	checkTemplates,
		activity
	)

Returns

Instance of type bool

     Checks that all the necessary rebar setup information is present.
     Args:
       checkTemplates: whether to check that there are rebar shape templates.
       activity: the activity that is being performed (e.g. add CMU wall).
     Returns: True if all the necessary setup information is present and
     False otherwise.
 
     C++ signature :
         bool CheckRebarSetupAndWarn(bool,std::string)

def Rebar.CreateRebarFromLayout	(	layout,
		defName,
		standardName,
		gradeName,
		coatingName,
		refPoint
	)

Returns

Instance of type ShapedRebarMaterial

Creates a rebar material from a Layout3D.
Args:
layout: The Layout3D from which to build a rebar shape consisting
of segments connected by bends. The layout must contain at least
two vertices and all vertices must be coplanar. The diameter of the
bends in the rebar shape will be two times the radii at the given
vertices. The negative of the depth vector at the first vertex will
be treated as the normal for the rebar shape. The normal is used to
determine how to adjust for the ReferencePoint (i.e. left/right/top/bottom).
If the depth vector is not normal to the rebar shape then an error will be
generated.
Note: a layout with 3 or more points has two valid normals, and
a layout with 2 points has infinitely many normals.
defName: the size designation of the rebar definition (e.g. #3).
standardName: the description of the rebar standard.
gradeName: the description of the rebar steel grade.
coatingName: the description of the rebar coating.
refPoint: the reference point location.

C++ signature :
Alloy::Pointer::Pointer<ShapedRebarMaterial> CreateRebarFromLayout(Layout3D {lvalue},std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint)

Creates a rebar material from a Layout3D.
Args:
layout: The Layout3D from which to build a rebar shape consisting
of segments connected by bends. The layout must contain at least
two vertices and all vertices must be coplanar. The diameter of the
bends in the rebar shape will be two times the radii at the given
vertices. The negative of the depth vector at the first vertex will
be treated as the normal for the rebar shape. The normal is used to
determine how to adjust for the ReferencePoint (i.e. left/right/top/bottom).
If the depth vector is not normal to the rebar shape then an error will be
generated.
Note: a layout with 3 or more points has two valid normals, and
a layout with 2 points has infinitely many normals.
defName: the size designation of the rebar definition (e.g. #3).
standardName: the description of the rebar standard.
gradeName: the description of the rebar steel grade.
coatingName: the description of the rebar coating.
refPoint: the reference point location.
submaterial_to_global: the submaterial to global transformation.

C++ signature :
Alloy::Pointer::Pointer<ShapedRebarMaterial> CreateRebarFromLayout(Layout3D {lvalue},std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint,Xform)

Note: Additional signature: CreateRebarFromLayout( (Layout3D)layout, (str)defName, (str)standardName, (str)gradeName, (str)coatingName, (ReferencePoint)refPoint, (Transform3D)submaterial_to_global) -> ShapedRebarMaterial

def Rebar.FitShapedRebarToDowels	(	templateName,
		defName,
		standardName,
		gradeName,
		coatingName,
		refPoint,
		dowels,
		showXform
	)

Returns

Instance of type ShapedRebarMaterial

Attempts to fit a rebar shape to a set of dowels. This function assumes
the dowels run orthogonal to the plane of the rebar shape.
Args:
shapeTemplate: the template for the rebar shape. The rebar shape
is expected to have all of its placement points on hooks or bends so they
can wrap around the dowels.
rebarDef: the definition for the type of rebar to use.
standardName: the description of the rebar standard.
gradeName: the description of the rebar steel grade.
coatingName: the description of the rebar coating.
refPoint: the rebar material reference point.
dowels: information about the dowels that the shape should be fitted
to. Each dowel is represented by a pair with the first element being the
location of the dowel and the second element being its diameter. The
number of dowels must be equal to the number of placement points defined
for the rebar shape or one less. If the number of dowels is one less then
the final placement point will wrap back to the first dowel. The locations
of the dowels must all be on an X-Y plane. The locations are assumed to be
in local coordinates.
showXform: the view transform. When applied to the dowel locations they are transformed to global coordinates.
Returns a shaped rebar material that is fit to the dowels as close as
possible.

C++ signature :
Alloy::Pointer::Pointer<ShapedRebarMaterial> FitShapedRebarToDowels(std::string,std::string,std::string,std::string,std::string,ShapedRebarMaterial::ReferencePoint,boost::python::api::object,Xform)

def Rebar.GetAvailableRebarCoatingNames ( standardName )

Returns

Instance of type list

     Lists the descriptions for all available rebar coatings for the specified standard.
     Args:
     standardName: The name of the rebar standard for which to
         retrieve available coating names.
 
     C++ signature :
         boost::python::list GetAvailableRebarCoatingNames(std::string)

def Rebar.GetAvailableRebarCoatings ( standard )

Returns

Instance of type list

     Lists all available rebar coatings for the specified standard.
     Args:
     standard: The rebar standard for which to retrieve available coatings.
 
     C++ signature :
         boost::python::list GetAvailableRebarCoatings(sj_rebar_standard)

def Rebar.GetAvailableRebarGradeNames ( standardName )

Returns

Instance of type list

     Lists the descriptions for all available rebar grades for the specified standard.
     Args:
     standardName: The name of the rebar standard for which to
         retrieve available grade names.
 
     C++ signature :
         boost::python::list GetAvailableRebarGradeNames(std::string)

def Rebar.GetAvailableRebarGrades ( standard )

Returns

Instance of type list

     Lists all available rebar grades for the specified standard.
     Args:
     standard: The rebar standard for which to retrieve available grades.
 
     C++ signature :
         boost::python::list GetAvailableRebarGrades(sj_rebar_standard)

def Rebar.GetFilteredRebarTemplates	(	min,
		max,
		tag
	)

Returns

Instance of type list

     Lists the names of the rebar templates available in the job that 
     have a placement point count that is between min and max.
     Args:
     min: The minimum number of placement points allowed.
     max: The maximum number of placement points allowed.
     tag: A tag that must be associated with the rebar shape, or the  empty string to not filter by tag.
     Returns the list of rebar templates that satisfy the parameters.
 
     C++ signature :
         boost::python::list GetFilteredRebarTemplates(int,int,std::string)

def Rebar.GetRebarTemplates ( args )

Returns

Instance of type list

     Lists the names of the rebar templates available in the job.
 
     C++ signature :
         boost::python::list GetRebarTemplates()

def Rebar.GetValidRebarStandardNames ( args )

Returns

Instance of type list

     Lists the descriptions for all valid rebar standards in the job.
 
     C++ signature :
         boost::python::list GetValidRebarStandardNames()

def Rebar.GetValidRebarStandards ( args )

Returns

Instance of type list

     Lists all valid rebar standards in the job.
 
     C++ signature :
         boost::python::list GetValidRebarStandards()

Variable Documentation

Rebar.BOTTOM = Rebar.ReferencePoint.BOTTOM

Rebar.BOTTOM_LEFT = Rebar.ReferencePoint.BOTTOM_LEFT

Rebar.BOTTOM_RIGHT = Rebar.ReferencePoint.BOTTOM_RIGHT

Rebar.CENTER = Rebar.ReferencePoint.CENTER

Rebar.LEFT = Rebar.ReferencePoint.LEFT

Rebar.RIGHT = Rebar.ReferencePoint.RIGHT

Rebar.TOP = Rebar.ReferencePoint.TOP

Rebar.TOP_LEFT = Rebar.ReferencePoint.TOP_LEFT

Rebar.TOP_RIGHT = Rebar.ReferencePoint.TOP_RIGHT

Classes

Functions

Variables

Function Documentation

Variable Documentation