Class AcCmTransparency

Class representing transparency similar to AutoCAD’s AcCmTransparency.

Stores both method and alpha information.

Index

Constructors

constructor

new AcCmTransparency(alpha?: number): AcCmTransparency
Creates a new transparency object.
Parameters
- Optionalalpha: number
  When provided, constructs with ByAlpha method and sets alpha. Must be between 0 and 255.
Returns AcCmTransparency
- Defined in packages/common/src/AcCmTransparency.ts:28

Accessors

alpha

get alpha(): number
Gets the alpha value. Only meaningful if method === ByAlpha.

Returns number
- Defined in packages/common/src/AcCmTransparency.ts:57
set alpha(alpha: number): void
Sets the alpha value and force the method to ByAlpha.
Parameters
- alpha: number
  0–255 alpha, clamped internally if out of range
Returns void
- Defined in packages/common/src/AcCmTransparency.ts:66

isByAlpha

get isByAlpha(): boolean
True if the method is ByAlpha.

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:136

isByBlock

get isByBlock(): boolean
True if the method is ByBlock.

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:143

isByLayer

get isByLayer(): boolean
True if the method is ByLayer.

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:150

isClear

get isClear(): boolean
True if transparency is exactly clear (alpha==0 and ByAlpha).

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:157

isInvalid

get isInvalid(): boolean
True if current state is invalid (ErrorValue).

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:171

isSolid

get isSolid(): boolean
True if transparency is solid (alpha==255 and ByAlpha).

Returns boolean
- Defined in packages/common/src/AcCmTransparency.ts:164

method

get method(): AcCmTransparencyMethod
Gets the current transparency method

Returns AcCmTransparencyMethod
- Defined in packages/common/src/AcCmTransparency.ts:39
set method(method: AcCmTransparencyMethod): void
Sets the transparency method. If setting to ByAlpha with no prior alpha, alpha stays 255 (opaque).
Parameters
- method: AcCmTransparencyMethod
  The new transparency method
Returns void
- Defined in packages/common/src/AcCmTransparency.ts:49

percentage

get percentage(): undefined | number
Gets the AutoCAD-style transparency percentage.

Mapping rules:
- 0% = fully opaque (alpha = 255)
- 100% = fully transparent (alpha = 0)
This matches how AutoCAD displays and stores transparency values in UI and DXF files.

If the transparency method is not ByAlpha, this method returns undefined, because AutoCAD does not define a percentage for ByLayer or ByBlock.
Returns undefined | number
Transparency percentage (0–100), or undefined
- Defined in packages/common/src/AcCmTransparency.ts:87
set percentage(percentage: number): void
Sets the transparency using an AutoCAD-style percentage.

Mapping rules (AutoCAD compatible):
- 0% → fully opaque (alpha = 255)
- 100% → fully transparent (alpha = 0)
Internally, the alpha value is calculated as: alpha = round(255 × (1 − percentage / 100))

This method:
- Forces the transparency method to ByAlpha
- Clamps the percentage to the range 0–100
- Preserves ObjectARX value semantics
Parameters
- percentage: number
  Transparency percentage (0–100)
Returns void
This instance (for fluent chaining)
Example
```
const t = new AcCmTransparency();
t.setPercentage(50); // ≈ alpha 128

t.setPercentage(0);   // alpha = 255 (opaque)
t.setPercentage(100); // alpha = 0   (clear)
```
- Defined in packages/common/src/AcCmTransparency.ts:120

Methods

clone

clone(): AcCmTransparency
Creates a deep copy of this transparency object.

This mirrors the value-semantics of ObjectARX AcCmTransparency, where copying results in an independent object with the same transparency method and alpha value.

Returns AcCmTransparency
A new AcCmTransparency instance with identical state.
- Defined in packages/common/src/AcCmTransparency.ts:198

equals

equals(other: AcCmTransparency): boolean
Compares this transparency with another one for equality.

Two AcCmTransparency objects are considered equal if:
- Their transparency methods are identical
- Their alpha values are identical
This mirrors the value semantics of ObjectARX AcCmTransparency.
Parameters
- other: AcCmTransparency
  The transparency to compare with
Returns boolean
True if both represent the same transparency
Example
```
const a = new AcCmTransparency(128);
const b = new AcCmTransparency(128);
a.equals(b); // true
```
- Defined in packages/common/src/AcCmTransparency.ts:223

serialize

serialize(): number
Convert this transparency to an integer suitable for storage. Uses a simple bit-encoding: highbits for method and lowbits for alpha.

31 24 23 8 7 0 +-------------+--------------+------------+ | flags | reserved | alpha | +-------------+--------------+------------+

Returns number
- Defined in packages/common/src/AcCmTransparency.ts:184

toString

toString(): string
Returns a human-readable string representation of the transparency.

Behavior:
- "ByLayer" if transparency is inherited from layer
- "ByBlock" if transparency is inherited from block
- Numeric alpha value ("0"–"255") if method is ByAlpha
This format is intentionally simple and mirrors common AutoCAD UI and DXF text usage.
Returns string
String representation of the transparency
Example
```
new AcCmTransparency().toString();        // "ByLayer"
new AcCmTransparency(128).toString();     // "128"
```
- Defined in packages/common/src/AcCmTransparency.ts:244

`Static`deserialize

deserialize(value: number): AcCmTransparency
Deserialize an integer back into a transparency object.
Parameters
- value: number
  32-bit stored transparency representation
Returns AcCmTransparency
- Defined in packages/common/src/AcCmTransparency.ts:300

`Static`fromString

fromString(value: string): AcCmTransparency
Creates an AcCmTransparency instance from a string representation.

Accepted formats:
- "ByLayer" (case-insensitive)
- "ByBlock" (case-insensitive)
- Numeric alpha value "0"–"255"
Invalid or out-of-range values will produce an ErrorValue transparency.
Parameters
- value: string
  String to parse
Returns AcCmTransparency
Parsed AcCmTransparency instance
Example
```
AcCmTransparency.fromString("ByLayer");
AcCmTransparency.fromString("128");
AcCmTransparency.fromString("ByBlock");
```
- Defined in packages/common/src/AcCmTransparency.ts:269

Class AcCmTransparency

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcCmTransparency

Accessors

alpha

Returns number

Parameters

Returns void

isByAlpha

Returns boolean

isByBlock

Returns boolean

isByLayer

Returns boolean

isClear

Returns boolean

isInvalid

Returns boolean

isSolid

Returns boolean

method

Returns AcCmTransparencyMethod

Parameters

Returns void

percentage

Returns undefined | number

Parameters

Returns void

Example

Methods

clone

Returns AcCmTransparency

equals

Parameters

Returns boolean

Example

serialize

Returns number

toString

Returns string

Example

Staticdeserialize

Parameters

Returns AcCmTransparency

StaticfromString

Parameters

Returns AcCmTransparency

Example

Settings

On This Page

`Static`deserialize

`Static`fromString