PatternProperties

Canonical path: NemAll_Python_BasisElements.PatternProperties

Properties of the pattern

Methods:

• SetBackgroundColorBGR –

  Set the background color

• SetBackgroundColorIRGB –

  Set the background color

• __eq__ –

  equal operator

• __init__ –

  dummy, is only needed for the creation of the documentation by MkDocs

• __repr__ –

  Convert to string

Attributes:

• BackgroundColor (ARGB) –

  Background color. Relevant if UseBackgroundColor is set to True

• IsScaleDependent (bool) –

  Whether the pattern is to be scale dependent

• PatternID (int) –

  Get the pattern ID

• PlacementType (PlacementType) –

  Placing mode

• ReferencePoint (Point2D) –

  reference point. Relevant if UseReferencePoint is set to True.

• RotationAngle (Angle) –

  Rotation angle

• UseBackgroundColor (bool) –

  Whether to use a background color in the pattern

• UseReferencePoint (bool) –

  Whether to use the reference point from ReferencePoint property for the pattern origin

• XScalingFactor (float) –

  Get the scaling factor in x direction

• YScalingFactor (float) –

  Get the scaling factor in y direction

BackgroundColor property writable

BackgroundColor: ARGB

Background color. Relevant if UseBackgroundColor is set to True

IsScaleDependent property writable

IsScaleDependent: bool

Whether the pattern is to be scale dependent

PatternID property writable

PatternID: int

Get the pattern ID

PlacementType property writable

PlacementType: PlacementType

Placing mode

ReferencePoint property writable

ReferencePoint: Point2D

reference point. Relevant if UseReferencePoint is set to True.

RotationAngle property writable

RotationAngle: Angle

Rotation angle

UseBackgroundColor property writable

UseBackgroundColor: bool

Whether to use a background color in the pattern

UseReferencePoint property writable

UseReferencePoint: bool

Whether to use the reference point from ReferencePoint property for the pattern origin

XScalingFactor property writable

XScalingFactor: float

Get the scaling factor in x direction

YScalingFactor property writable

YScalingFactor: float

Get the scaling factor in y direction

SetBackgroundColorBGR

SetBackgroundColorBGR(value: int)

Set the background color

Parameters:

• value (int) –

  Color value as BGR

SetBackgroundColorIRGB

SetBackgroundColorIRGB(value: int)

Set the background color

Parameters:

• value (int) –

  Color value as IRGB

__eq__

__eq__(prop: PatternProperties) -> bool

equal operator

Parameters:

• prop (PatternProperties) –

  PatternProperties to compare

Returns:

• bool –

  true if they are equal, false otherwise

__init__ overloaded

__init__()

Initialize

__init__(element: PatternProperties)

Copy constructor

Parameters:

• element (PatternProperties) –

  Element to copy

__repr__

__repr__() -> str

Convert to string