dbGetPatternRegionName

dbGetPatternRegionName(
d_shapeId
)
=> t_name / nil 

Description

(ICADVM20.1 Only) Returns the name of the pattern region set for the specified shape.

Arguments

d_shapeId

The ID of the shape.

Value Returned

t_name	The name of the pattern region.
nil	Returned in case of failure.

Example

The shape rect does not contain pattern region information.

rect = dbCreateRect(cv '("Metal1" "drawing") '((0 0) (10 10)))

> db:0x2c4be89e 

dbHasPatternRegionInfo(rect)

> nil

dbGetPatternRegionName(rect)

> *WARNING* (DB-220061): dbGetPatternRegionName: This shape ID has no pattern region info.

> nil

Pattern region information is assigned to the shape rect.

dbSetPatternRegionAllowedPatterns(rect '("1X"))

> t

dbHasPatternRegionInfo(rect)

> t

The default name of a pattern region is an empty string.

dbGetPatternRegionName(rect)

> ""

The pattern region "rect" has been set for the specified shape.

dbSetPatternRegionName(rect "rect")

> t

dbGetPatternRegionName(rect)

> "rect"

Return to top