NemAll_Python_ArchElements

Exposed classes and functions from NemAll_Python_ArchElements

 
Classes
       
Boost.Python.instance(builtins.object)
AllplanElement
ArchElement
WallElement
AxisProperties
BottomTopPlaneService
ElementConverter
PlaneReferences
PropertyDialogs
ReferencePlaneID
WallProperties
WallTierProperties

 
class AllplanElement(Boost.Python.instance)
    
Method resolution order:
AllplanElement
Boost.Python.instance
builtins.object

Static methods defined here:
GetAttributes(...)
GetAttributes( (AllplanElement)arg1) -> object :
    Get the attributes object
    
    Return:  Attributes object
GetCommonProperties(...)
GetCommonProperties( (AllplanElement)arg1) -> CommonProperties :
    Get the common properties
    
    Return:  Common properties
GetGeometryObject(...)
GetGeometryObject( (AllplanElement)arg1) -> object :
    Get the geometry object
    
    Return:  Geometry object
GetLabelElements(...)
GetLabelElements( (AllplanElement)arg1) -> list :
    Get the label elements
    
    Return:  LabelElements
SetAttributes(...)
SetAttributes( (AllplanElement)arg1, (object)attributesObject) -> None :
    Set the attributes object
    
    Parameter: attributesObject  Attributes object
SetCommonProperties(...)
SetCommonProperties( (AllplanElement)arg1, (CommonProperties)commonProp) -> None :
    Set the common properties
    
    Parameter: commonProp  Common properties
SetGeometryObject(...)
SetGeometryObject( (AllplanElement)arg1, (object)geometryObject) -> None :
    Set the geometry object
    
    Parameter: geometryObject  Geometry object
SetLabelElements(...)
SetLabelElements( (AllplanElement)arg1, (list)labelElements) -> None :
    Set the label elements
    
    Parameter: labelElements  Label elements
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class ArchElement(AllplanElement)
    
Method resolution order:
ArchElement
AllplanElement
Boost.Python.instance
builtins.object

Static methods defined here:
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods inherited from AllplanElement:
GetAttributes(...)
GetAttributes( (AllplanElement)arg1) -> object :
    Get the attributes object
    
    Return:  Attributes object
GetCommonProperties(...)
GetCommonProperties( (AllplanElement)arg1) -> CommonProperties :
    Get the common properties
    
    Return:  Common properties
GetGeometryObject(...)
GetGeometryObject( (AllplanElement)arg1) -> object :
    Get the geometry object
    
    Return:  Geometry object
GetLabelElements(...)
GetLabelElements( (AllplanElement)arg1) -> list :
    Get the label elements
    
    Return:  LabelElements
SetAttributes(...)
SetAttributes( (AllplanElement)arg1, (object)attributesObject) -> None :
    Set the attributes object
    
    Parameter: attributesObject  Attributes object
SetCommonProperties(...)
SetCommonProperties( (AllplanElement)arg1, (CommonProperties)commonProp) -> None :
    Set the common properties
    
    Parameter: commonProp  Common properties
SetGeometryObject(...)
SetGeometryObject( (AllplanElement)arg1, (object)geometryObject) -> None :
    Set the geometry object
    
    Parameter: geometryObject  Geometry object
SetLabelElements(...)
SetLabelElements( (AllplanElement)arg1, (list)labelElements) -> None :
    Set the label elements
    
    Parameter: labelElements  Label elements

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class AxisProperties(Boost.Python.instance)
    Axis properties
 
 
Method resolution order:
AxisProperties
Boost.Python.instance
builtins.object

Static methods defined here:
__init__(...)
__init__( (object)arg1) -> None
__reduce__ = (...)
__repr__(...)
__repr__( (AxisProperties)arg1) -> str

Data descriptors defined here:
Distance
Set/get the distance
Extension
Set/get the extension
Modus
Set/get the modus
OnLayer
Property for the axis layer
Position
Property for the axis position

Data and other attributes defined here:
WallAxisPosition = <class 'NemAll_Python_ArchElements.WallAxisPosition'>
Position of the wall axis
__instance_size__ = 40
eCenter = NemAll_Python_ArchElements.WallAxisPosition.eCenter
eFree = NemAll_Python_ArchElements.WallAxisPosition.eFree
eLeft = NemAll_Python_ArchElements.WallAxisPosition.eLeft
eRight = NemAll_Python_ArchElements.WallAxisPosition.eRight
eUnknown = NemAll_Python_ArchElements.WallAxisPosition.eUnknown

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class BottomTopPlaneService(Boost.Python.instance)
    
Method resolution order:
BottomTopPlaneService
Boost.Python.instance
builtins.object

Static methods defined here:
GetAbsoluteBottomElevation(...)
GetAbsoluteBottomElevation( (DocumentAdapter)doc, (PlaneReferences)planeProp) -> float :
    Get the absolute elevation of the bottom plane
    
    Parameter: doc        Document
               planeProp  Plane properties
    
    Return:  Elevation of the bottom plane
GetAbsoluteTopElevation(...)
GetAbsoluteTopElevation( (DocumentAdapter)doc, (PlaneReferences)planeProp) -> float :
    Get the absolute top elevation
    
    Parameter: doc        Document
               planeProp  Plane properties
    
    Return:  Absolute top elevation
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class ElementConverter(Boost.Python.instance)
    Element converter
 
 
Method resolution order:
ElementConverter
Boost.Python.instance
builtins.object

Static methods defined here:
ConvertToUDElement(...)
ConvertToUDElement( (BaseElementAdapterList)elements) -> BaseElementAdapterList :
    Create UD element from arbitrary 3D elements
    
    Parameter: elements    Elements
__init__(...)
__init__( (object)arg1) -> None
__reduce__ = (...)

Data and other attributes defined here:
__instance_size__ = 24

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class PlaneReferences(Boost.Python.instance)
    
Method resolution order:
PlaneReferences
Boost.Python.instance
builtins.object

Static methods defined here:
GetBottomPlaneDependency(...)
GetBottomPlaneDependency( (PlaneReferences)arg1) -> PlaneReferenceDependency :
    Get the bottom plane dependency
GetTopPlaneDependency(...)
GetTopPlaneDependency( (PlaneReferences)arg1) -> PlaneReferenceDependency :
    Get the top plane dependency
SetBottomElevation(...)
SetBottomElevation( (PlaneReferences)arg1, (float)elevation) -> None :
    Set the bottom plane elevation
    
    Parameter: elevation  Elevation
SetBottomPlaneDependency(...)
SetBottomPlaneDependency( (PlaneReferences)arg1, (PlaneReferenceDependency)dependency) -> None :
    Set the bottom plane dependency
    
    Parameter: dependency  Dependency
SetTopElevation(...)
SetTopElevation( (PlaneReferences)arg1, (float)elevation) -> None :
    Set the top plane elevation
    
    Parameter: elevation  Elevation
SetTopPlaneDependency(...)
SetTopPlaneDependency( (PlaneReferences)arg1, (PlaneReferenceDependency)dependency) -> None :
    Set the top plane dependency
    
    Parameter: dependency  Dependency
__init__(...)
__init__( (object)arg1) -> None
 
__init__( (object)arg1) -> object :
    Constructor
    
 
__init__( (object)arg1, (PlaneReferences)arg2) -> object :
    Copy constructor
__reduce__ = (...)
__repr__(...)
__repr__( (PlaneReferences)arg1) -> str

Data descriptors defined here:
AdaptTopLevelToPlane
Set/get top level to plane adaption
Direction
Set/get the direction
LowerPlane
Set/get lower plane
MaxHeight
Set/get the maximal height
UpperPlane
Set/get upper plane

Data and other attributes defined here:
PlaneReferenceDependency = <class 'NemAll_Python_ArchElements.PlaneReferenceDependency'>
Plane reference Dependency
__instance_size__ = 136
eAbsElevation = NemAll_Python_ArchElements.PlaneReferenceDependency.eAbsElevation
eBottomPlane = NemAll_Python_ArchElements.PlaneReferenceDependency.eBottomPlane
eTopPlane = NemAll_Python_ArchElements.PlaneReferenceDependency.eTopPlane

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class PropertyDialogs(Boost.Python.instance)
    
Method resolution order:
PropertyDialogs
Boost.Python.instance
builtins.object

Static methods defined here:
GetTradeDescription(...)
GetTradeDescription( (WallAxisPosition)arg1) -> str
OpenAttributeSelectionDialog(...)
OpenAttributeSelectionDialog( (DocumentAdapter)doc) -> int :
    Open the attribute selection dialog
    
    Parameter: doc  Document
    
    Return:  Attribute ID
OpenBottomPlaneReferenceDialog(...)
OpenBottomPlaneReferenceDialog( (DocumentAdapter)doc, (PlaneReferences)planeRefs) -> float :
    Open the plane references dialog
    
    Return:    bottom height
    
    Parameter: doc        Document
               planeRefs  Plane references
OpenPlaneReferencesDialog(...)
OpenPlaneReferencesDialog( (DocumentAdapter)doc, (PlaneReferences)planeRefs) -> None :
    Open the plane references dialog
    
    Parameter: doc        Document
               planeRefs  Plane references
OpenTradeDialog(...)
OpenTradeDialog( (DocumentAdapter)doc, (WallAxisPosition)tradeID) -> int :
    Open the trade dialog
    
    Parameter: doc      Document
               tradeID  Current trade ID
    
    Return:  Trade ID
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class ReferencePlaneID(Boost.Python.instance)
    Reference plane ID
 
 
Method resolution order:
ReferencePlaneID
Boost.Python.instance
builtins.object

Static methods defined here:
ChangeModel(...)
ChangeModel( (ReferencePlaneID)arg1, (GUID)arg2) -> None :
    change model id to another
Invalidate(...)
Invalidate( (ReferencePlaneID)arg1) -> None :
    Set values to undefined state
IsDefaultLowerPlane(...)
IsDefaultLowerPlane( (ReferencePlaneID)arg1) -> bool :
    Find out if reference plane is default lower reference plane
    
    Return:  true if ref plane is default lower ref plane
IsDefaultUpperPlane(...)
IsDefaultUpperPlane( (ReferencePlaneID)arg1) -> bool :
    Find out if reference plane is default upper reference plane
    
    Return:  true if ref plane is default upper ref plane
IsDocumentRefSurface(...)
IsDocumentRefSurface( (ReferencePlaneID)arg1) -> bool :
    Find out if reference surface is from document
    
    Return:  true is reference surface from document (not in model)
IsInModel(...)
IsInModel( (ReferencePlaneID)arg1) -> bool :
    Find out if refrence plane is in model
    
    Return:  true if ref plane is in model
IsValid(...)
IsValid( (ReferencePlaneID)arg1) -> bool :
    Get validity of ref plane
    
    Return:  true if ref plane is valid
SetCustomLowerPlane(...)
SetCustomLowerPlane( (ReferencePlaneID)arg1) -> None :
    Set values to custom lower state
SetCustomUpperPlane(...)
SetCustomUpperPlane( (ReferencePlaneID)arg1) -> None :
    Set values to custom upper state
__eq__(...)
__eq__( (ReferencePlaneID)arg1, (ReferencePlaneID)other) -> object :
    Equal operator
    
    Parameter: other  Plane reference ID to compare
    
    Return:  Reference plan ID's are equal: true/false
__init__(...)
__init__( (object)arg1) -> None
 
__init__( (object)arg1, (GUID)modelGuid, (WallAxisPosition)planeId) -> None :
    Constructor
    
    Parameter: modelGuid  Plane UUID
               planeId    Plane ID
__lt__(...)
__lt__( (ReferencePlaneID)arg1, (ReferencePlaneID)other) -> object :
    Less than operator
    
    Parameter: other  Plane reference ID to compare
    
    Return:  Reference plan ID is less than other: true/false
__ne__(...)
__ne__( (ReferencePlaneID)arg1, (ReferencePlaneID)other) -> object :
    Not equal operator
    
    Parameter: other  Plane reference ID to compare
    
    Return:  Reference plan IDS' are not equal: true/false
__reduce__ = (...)
__repr__(...)
__repr__( (ReferencePlaneID)arg1) -> str

Data and other attributes defined here:
__instance_size__ = 40

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class WallElement(ArchElement)
    
Method resolution order:
WallElement
ArchElement
AllplanElement
Boost.Python.instance
builtins.object

Static methods defined here:
__init__(...)
__init__( (object)arg1) -> None
 
__init__( (object)arg1, (WallProperties)wallProp, (object)axis) -> None :
    Constructor
    
    Parameter: wallProp  Wall properties
               axis      Axis
__reduce__ = (...)

Data and other attributes defined here:
__instance_size__ = 120

Static methods inherited from AllplanElement:
GetAttributes(...)
GetAttributes( (AllplanElement)arg1) -> object :
    Get the attributes object
    
    Return:  Attributes object
GetCommonProperties(...)
GetCommonProperties( (AllplanElement)arg1) -> CommonProperties :
    Get the common properties
    
    Return:  Common properties
GetGeometryObject(...)
GetGeometryObject( (AllplanElement)arg1) -> object :
    Get the geometry object
    
    Return:  Geometry object
GetLabelElements(...)
GetLabelElements( (AllplanElement)arg1) -> list :
    Get the label elements
    
    Return:  LabelElements
SetAttributes(...)
SetAttributes( (AllplanElement)arg1, (object)attributesObject) -> None :
    Set the attributes object
    
    Parameter: attributesObject  Attributes object
SetCommonProperties(...)
SetCommonProperties( (AllplanElement)arg1, (CommonProperties)commonProp) -> None :
    Set the common properties
    
    Parameter: commonProp  Common properties
SetGeometryObject(...)
SetGeometryObject( (AllplanElement)arg1, (object)geometryObject) -> None :
    Set the geometry object
    
    Parameter: geometryObject  Geometry object
SetLabelElements(...)
SetLabelElements( (AllplanElement)arg1, (list)labelElements) -> None :
    Set the label elements
    
    Parameter: labelElements  Label elements

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class WallProperties(Boost.Python.instance)
    
Method resolution order:
WallProperties
Boost.Python.instance
builtins.object

Static methods defined here:
GetTierCount(...)
GetTierCount( (WallProperties)arg1) -> int :
    Get the tier count
    
    Return:  Tier count
GetWallTierProperties(...)
GetWallTierProperties( (WallProperties)arg1, (WallAxisPosition)tierIndex) -> WallTierProperties :
    Get the wall tier properties
    
    Parameter: tierIndex  Tier index
    
    Return:  Wall tier properties
LoadFromFavoriteFile(...)
LoadFromFavoriteFile( (WallProperties)arg1, (DocumentAdapter)doc) -> None :
    Load the properties from the favorite file
    
    Parameter: doc  Document
SetAxis(...)
SetAxis( (WallProperties)arg1, (AxisProperties)axis) -> None :
    Set the axis
    
    Parameter: axis  Axis properties
SetTierCount(...)
SetTierCount( (WallProperties)arg1, (WallAxisPosition)tierCount) -> None :
    Set the tier count
    
    Parameter: tierCount  Tier count
__init__(...)
__init__( (object)arg1) -> None
 
__init__( (object)arg1, (WallProperties)wallProp) -> None :
    Copy constructor
    
    Parameter: wallProp  Wall properties
__reduce__ = (...)

Data and other attributes defined here:
__instance_size__ = 24

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class WallTierProperties(Boost.Python.instance)
    
Method resolution order:
WallTierProperties
Boost.Python.instance
builtins.object

Static methods defined here:
ResetBackgroundColor(...)
ResetBackgroundColor( (WallTierProperties)arg1) -> None :
    Reset the background color
SetAttribute(...)
SetAttribute( (WallTierProperties)arg1, (object)attrib) -> None :
    Set the attribute
    
    Parameter: attrib  Attribute
SetBackgroundColor(...)
SetBackgroundColor( (WallTierProperties)arg1, (WallAxisPosition)colorID) -> None :
    Set the background color
    
    Parameter: colorID  Background color ID
SetCommonProperties(...)
SetCommonProperties( (WallTierProperties)arg1, (CommonProperties)comProp) -> None :
    Set the common properties
    
    Parameter: comProp  Common properties
SetFaceStyle(...)
SetFaceStyle( (WallTierProperties)arg1, (WallAxisPosition)faceStyleID) -> None :
    Set the face style
    
    Parameter: faceStyleID  Face style ID
SetFilling(...)
SetFilling( (WallTierProperties)arg1, (WallAxisPosition)fillingID) -> None :
    Set the filling
    
    Parameter: fillingID  Filling ID
SetHatch(...)
SetHatch( (WallTierProperties)arg1, (WallAxisPosition)hatchID) -> None :
    Set the hatch
    
    Parameter: hatchID  Hatch ID
SetMaterial(...)
SetMaterial( (WallTierProperties)arg1, (wstring)material) -> None :
    Set the material
    
    Parameter: material  Material
SetPattern(...)
SetPattern( (WallTierProperties)arg1, (WallAxisPosition)patternID) -> None :
    Set the pattern
    
    Parameter: patternID  Pattern ID
SetPlaneReferences(...)
SetPlaneReferences( (WallTierProperties)arg1, (PlaneReferences)arg2) -> None :
    Set the plane references
SetThickness(...)
SetThickness( (WallTierProperties)arg1, (float)thickness) -> None :
    Set the thickness
    
    Parameter: thickness  Thickness
    
    Return:  missing !!!
SetTrade(...)
SetTrade( (WallTierProperties)arg1, (WallAxisPosition)value) -> None :
    Set the trade
    
    Parameter: value  Trade index
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__