BitmapAreaProperties

Canonical path: NemAll_Python_BasisElements.BitmapAreaProperties

Properties of the bitmap area.

Methods:

• SetTransparentColorAlpha –

  Set the first color alpha

• SetTransparentColorBGR –

  Set the first color

• SetTransparentColorIRGB –

  Set the first color

• __eq__ –

  equal operator

• __init__ –

  Overloaded function. See individual overloads.

• __repr__ –

  Convert to string

Attributes:

• BitmapName (str) –

  Get the bitmapname

• DirectionToReferenceLine (int) –

  Get the index of the direction line

• ReferencePoint (Point2D) –

  Get the reference point

• RotationAngle (Angle) –

  Get the rotation angle

• SketchingTexture (bool) –

  Get the bitmap is sketching texture state

• TransparentColor (ARGB) –

  Get the first color

• TransparentColorTolerance (int) –

  Get the transparent color tolerance

• UseDirectionToReferenceLine (bool) –

  Get the direction to reference line state

• UseMetricalValues (bool) –

  Get the metrical value state

• UsePixelMask (bool) –

  Get the make black pixels transparent state

• UseReferencePoint (bool) –

  Get the use reference point state

• UseRepeatTile (bool) –

  Get the repeat tile state

• XOffset (float) –

  Get the offset in x direction

• XScalingFactor (float) –

  Get the scaling factor in x direction

• XShearingFactor (float) –

  Get the shearing factor in x direction

• YOffset (float) –

  Get the offset in y direction

• YScalingFactor (float) –

  Get the scaling factor in y direction

• YShearingFactor (float) –

  Get the shearing factor in y direction

BitmapName property writable

BitmapName: str

Get the bitmapname

DirectionToReferenceLine property writable

DirectionToReferenceLine: int

Get the index of the direction line

ReferencePoint property writable

ReferencePoint: Point2D

Get the reference point

RotationAngle property writable

RotationAngle: Angle

Get the rotation angle

SketchingTexture property writable

SketchingTexture: bool

Get the bitmap is sketching texture state

TransparentColor property writable

TransparentColor: ARGB

Get the first color

TransparentColorTolerance property writable

TransparentColorTolerance: int

Get the transparent color tolerance

UseDirectionToReferenceLine property writable

UseDirectionToReferenceLine: bool

Get the direction to reference line state

UseMetricalValues property writable

UseMetricalValues: bool

Get the metrical value state

UsePixelMask property writable

UsePixelMask: bool

Get the make black pixels transparent state

UseReferencePoint property writable

UseReferencePoint: bool

Get the use reference point state

UseRepeatTile property writable

UseRepeatTile: bool

Get the repeat tile state

XOffset property writable

XOffset: float

Get the offset in x direction

XScalingFactor property writable

XScalingFactor: float

Get the scaling factor in x direction

XShearingFactor property writable

XShearingFactor: float

Get the shearing factor in x direction

YOffset property writable

YOffset: float

Get the offset in y direction

YScalingFactor property writable

YScalingFactor: float

Get the scaling factor in y direction

YShearingFactor property writable

YShearingFactor: float

Get the shearing factor in y direction

SetTransparentColorAlpha

SetTransparentColorAlpha(value: int)

Set the first color alpha

Parameters:

• value (int) –

  Alpha value of the first color

SetTransparentColorBGR

SetTransparentColorBGR(value: int)

Set the first color

Parameters:

• value (int) –

  BGR color value

SetTransparentColorIRGB

SetTransparentColorIRGB(value: int)

Set the first color

Parameters:

• value (int) –

  IRGB color value

__eq__

__eq__(prop: BitmapAreaProperties) -> bool

equal operator

Parameters:

• prop (BitmapAreaProperties) –

  BitmapProperties to compare

Returns:

• bool –

  true if they are equal, false otherwise

__init__ overloaded

__init__()

Initialize

__init__(props: BitmapAreaProperties)

Copy constructor

Parameters:

• props (BitmapAreaProperties) –

  Properties to copy

__repr__

__repr__() -> str

Convert to string

Placeholder