DCEDrawingLayer

The layers that contains DrawingItems. Users can add configurations for the DrawingItems via DCEDrawingLayer

@interface DCEDrawingLayer

initWithId

The constructor of the DCEDrawingLayer class. Initialize the instance of the DCEDrawingLayer class.

- (instancetype) initWithId:(NSInteger)id;

Parameters

id: Indicates the id of the layer.

Remarks

Please initialize the DrawingLayers via the following methods:

• DCEImageEditorView.createDrawingLayer
• DCECameraView.createDrawingLayer

id

The ID of the DrawingLayer.

@property (assign, nonatomic) NSInteger id;

The ID can be one of the following:

• DDN_LAYER_ID
• DBR_LAYER_ID
• DLR_LAYER_ID
• USER_DEFINED_LAYER_BASE_ID

drawingItems

The property that stores all the DrawingItems on the layer. This property determines which DrawingItems will be displayed on the layer.

@property (nonatomic, strong, readwrite, nullable) NSArray<DrawingItem *> *drawingItems;

addDrawingItems

Add a list of DrawingItems to the DrawingLayer. These DrawingItems will be appended to the property drawingItems.

- (void) addDrawingItems:(NSArray<DrawingItem*>*)items; 

Parameters

items: A list of DrawingItems.

Code Snippet

• Objective-C
• Swift

1. // Create a new DrawingItem array.
   NSMutableArray<DrawingItem *> *array = [NSMutableArray array];
   // You can append QuadDrawingItems, RectDrawingItems and TextDrawingItems in the array.
   // For example, we use QuadDrawingItems here. The quad data here is obtained from Dynamsoft Document Normalizer
   for (iDetectedQuadResult *detectedQuadResult in [StaticClass instance].quadArr) {
      iQuadrilateral *quad = detectedQuadResult.location;
      QuadDrawingItem *quadItem = [[QuadDrawingItem alloc] initWithQuad:quad];
      [array addObject:quadItem];
   }
   layer.drawingItems = array;
   

2. // Create a new DrawingItem array.
   var array:[DrawingItem]? = []
   // You can append QuadDrawingItems, RectDrawingItems and TextDrawingItems in the array.
   // For example, we use QuadDrawingItems here. The quad data here is obtained from Dynamsoft Document Normalizer
   for detectQuadResult in StaticClass.instance.quadArray{
      let quad = detectQuadResult.location
      let quadItem = QuadDrawingItem.init(quad: quad)
      array?.append(quadItem)
   }
   // Assign the new DrawingItem array to the drawingItems.
   layer.drawingItems = array
   

setDrawingStyleId

Specify a style ID for all available DrawingItems.

- (void) setDrawingStyleId:(NSInteger)styleId;

Parameters

styleId: The style ID.

Code Snippet

• Objective-C
• Swift

1. [drawingLayer setDrawingStyleId:0];
   

2. drawingLayer.setDrawingStyleId(0)
   

setDrawingStyleId:state:

Specify a style ID for the targeting DrawingItems. The stateis a filter of the DrawingItems. All the eligible DrawingItems will be changed to the input style.

- (void) setDrawingStyleId:(NSInteger)styleId
                     state:(EnumDrawingItemState)state;

Parameters

styleId: The style ID.
state: The state of the DrawingItem.

Code Snippet

• Objective-C
• Swift

1. [drawingLayer setDrawingStyleId:0 state:EnumDrawingItemStateSelected];
   

2. drawingLayer.setDrawingStyleId(0, state:EnumDrawingItemState.selected)
   

setDrawingStyleId:state:mediaType:

Specify a style ID for the targeting DrawingItems. The state and mediaType are filters of the DrawingItems. All the eligible DrawingItems will be changed to the input style.

- (void) setDrawingStyleId:(NSInteger)styleId
                     state:(EnumDrawingItemState)state
                mediaTypes:(NSArray*)mediaTypes;

Parameters

styleId: The style ID.
state: The state of the DrawingItem.
mediaType: The media type of the DrawingItem.

Code Snippet

• Objective-C
• Swift

1. [drawingLayer setDrawingStyleId:0 state:EnumDrawingItemStateSelected mediaType:@[@(EnumDrawingItemMediaTypeRectangle), @(EnumDrawingItemMediaTypeQuadrilateral)]];
   

2. drawingLayer.setDrawingStyleId(0, state:EnumDrawingItemState.selected, mediaType:[EnumDrawingItemMediaType.quadrilateral.rawValue, EnumDrawingItemMediaType.rectangle.rawValue])
   

visible

The property that stores the visibility of the DrawingLayer.

@property (assign, nonatomic) BOOL visible;

Remarks

When visible is true, the DrawingLayer is visible. Otherwise, the DrawingLayer is invisible.