The CSWhiteboardSurface object represents independent whiteboard surface containing all shapes drawn on given whiteboard surface.
More...
#import <CSWhiteboardSurface.h>
Inherits NSObject.
Inherited by CSSlide.
The CSWhiteboardSurface object represents independent whiteboard surface containing all shapes drawn on given whiteboard surface.
Whiteboard surface content is displayed on CSIOSWhiteboardCanvas. Client can obtain objects of this class using methods of class CSWhiteboard. Methods related to adding/modifying/removing particular shapes shouldn't be invoked by client explicitly unless custom whiteboard canvas is developed. Methods NSObject::isEqual and NSObject::hash are implemented for this class.
- See also
- CSWhiteboard
- (CSCircleShape *) addCircleWithTopLeft: |
|
(CSShapePoint *) |
topLeft |
bottomRight: |
|
(CSShapePoint *) |
bottomRight |
color: |
|
(NSUInteger) |
color |
width: |
|
(NSUInteger) |
width |
isFilled: |
|
(BOOL) |
filled |
completionHandler: |
|
(void(^)(CSBasicShape *shape, NSError *error)) |
handler |
|
|
| |
Adds a circle to the whiteboard surface.
Method is deprecated. Use addCircleWithTopLeft:bottomRight:color:width:isFilled:completionHandler: instead.
- Parameters
-
topLeft | Top left point of circle |
bottomRight | Bottom right point of circle. |
color | Color of circle. |
width | Width of circle. |
filled | True if circle is filled. |
handler | A block to be called when the operation is completed.
shape Added circle as CSBasicShape object.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
- Returns
- CSCircleShape object made with given parameters
- (CSShape *) addShapeWithPoints: |
|
(NSArray *) |
points |
color: |
|
(NSUInteger) |
color |
width: |
|
(NSUInteger) |
width |
isFilled: |
|
(BOOL) |
filled |
isFinished: |
|
(BOOL) |
finished |
completionHandler: |
|
(void(^)(CSBasicShape *shape, NSError *error)) |
handler |
|
|
| |
Adds a shape to the whiteboard surface.
- Parameters
-
points | Array of CSShapePoint points. |
color | Color of shape. |
width | Width of shape. |
filled | True if shape is filled. |
finished | Set to true when shape is finished / closed |
handler | A block to be called when the operation is completed.
shape CSBasicShape object made with given points.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
- Returns
- CSShape object made with given points
- (CSWhiteboardText *) addText: |
|
(NSString *) |
text |
atPosition: |
|
(CSShapePoint *) |
position |
fontSize: |
|
(NSUInteger) |
fontSize |
color: |
|
(NSUInteger) |
color |
completionHandler: |
|
(void(^)(CSBasicShape *shape, NSError *error)) |
handler |
|
|
| |
Adds a text to the whiteboard surface.
Method is deprecated. Use addText:atPosition:fontSize:color:completionHandler: instead.
- Parameters
-
text | Content of the whiteboard text object. |
position | Position of the text on the whiteboard surface. |
fontSize | Font size of the text. |
color | Color of the text. |
handler | A block to be called when the operation is completed.
shape Added text as CSBasicShape object.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
- Returns
- CSWhiteboardText object made with given parameters.
- (void) clearContentWithCompletionHandler: |
|
(void(^)(CSWhiteboardSurface *surface, NSError *error)) |
handler |
|
Removes all content from the drawing surface.
It shouldn't be used by client unless custom whiteboard canvas is developed. See CSWhiteboardCanvas::clearWhiteboardWithCompletionHandler: and CSIOSWhiteboardCanvas::clearWhiteboardWithCompletionHandler.
- Parameters
-
handler | A block to be called when the operation is completed.
surface Shape that was cleared if operation was successful.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
- See also
- CSWhiteboardCanvas::clearWhiteboardWithCompletionHandler:
-
- clearWhiteboardWithCompletionHandler: (CSIOSWhiteboardCanvas)
Deletes a shape from surface.
- Parameters
-
shape | CSBasicShape object to be deleted from whiteboard surface. |
handler | A block to be called when the operation is completed.
shape Deleted shape.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
Marks shape as finished.
- Parameters
-
shape | CSBasicShape to be marked as finished. |
handler | A block to be called when the operation is completed.
shape CSBasicShape object marked as finished.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
- See also
- - finishShape:completionHandler:
Selects this surface as the active whiteboard surface.
Only one surface can be active during a collaboration session.
- Parameters
-
handler | A block to be called when the operation is completed.
surface CSWhiteboardSurface object set as active.
participant CSParticipant object providing information about collaboration participant who set surface as active (local user in case of this method).
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
Updates given shape.
Can be used to continue drawing or to move given shape.
- Parameters
-
shape | CSBasicShape to be updated or moved. |
handler | A block to be called when the operation is completed.
shape Updated/moved shape.
error If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error.
|
Data of participant who added whiteboard surface.
The delegate used to handle events related to whiteboard surface.
Data of participant who removed whiteboard surface.
CSCapability object indicating whether the local user is allowed to set given whiteboard surface active.
To do so, the local user needs to be moderator, presenter or panel model mode has to be enabled.
- See also
- - setAsActiveWithCompletionHandler:
The documentation for this class was generated from the following file: