PanoAnnotation, 标注的核心接口更多...

#include <PanoAnnotation.h>

类
class	Callback
	PanoAnnotation 的回调函数，在使用 PanoAnnotation 之前必须要设置回调以获取事件通知。更多...

Public 成员函数
virtual QResult	setCallback (Callback *callback)=0
	设置标注回调函数，用以接收标注事件消息

virtual QResult	setRoleType (WBRoleType type)=0
	设置标注角色类型。更多...

virtual QResult	startAnnotation (void *window)=0
	开启标注并且设置显示窗口更多...

virtual QResult	stopAnnotation ()=0
	停止标注更多...

virtual QResult	setVisible (bool visible)=0
	设置标注视图是否可见更多...

virtual QResult	addToolboxView (void *window)=0
	增加工具栏窗口更多...

virtual QResult	removeToolboxView (void *window)=0
	移除工具栏窗口更多...

virtual QResult	setToolType (WBToolType type)=0
	设置工具类型更多...

virtual QResult	setLineWidth (int size)=0
	设置线宽更多...

virtual QResult	setColor (WBColor color)=0
	设置颜色更多...

virtual QResult	setFillType (WBFillType type)=0
	设置填充类型更多...

virtual QResult	setFillColor (WBColor color)=0
	设置填充颜色更多...

virtual QResult	setFontStyle (WBFontStyle style)=0
	设置字体样式更多...

virtual QResult	setFontSize (int size)=0
	设置字体大小更多...

virtual QResult	undo ()=0
	撤消上一次操作更多...

virtual QResult	redo ()=0
	重做标注的上一次被撤销操作更多...

virtual QResult	clearUserContents (uint64_t userId)=0
	清除指定用户标注内容更多...

virtual QResult	clearContents ()=0
	清除标注内容，需要 ADMIN 角色才可调用成功更多...

virtual QResult	snapshot (const char *outputDir)=0
	保存标注内容到图像。更多...

virtual WBToolType	getToolType ()=0
	获取工具类型更多...

virtual QResult	setAspectSize (int32_t w, int32_t h)=0
	设置标注区域大小更多...

virtual QResult	setScalingMode (WBScalingMode mode)=0
	设置标注区域缩放模式更多...

virtual QResult	setWindowPos (WBRect rect)=0
	设置标注窗口位置及大小。更多...

virtual QResult	setOption (AnnoOption option, void *param, size_t size)=0
	设置标注参数更多...

virtual QResult	setExtAnnoMode (ExternalAnnoMode mode)=0
	设置外部标注模式。仅对外部标注有效。更多...

Protected 成员函数
virtual	~PanoAnnotation ()=default
	析构函数

详细描述

PanoAnnotation, 标注的核心接口

成员函数说明

◆ addToolboxView()

virtual QResult PanoAnnotation::addToolboxView ( void * window )

pure virtual

增加工具栏窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

◆ clearContents()

virtual QResult PanoAnnotation::clearContents ( )

pure virtual

清除标注内容，需要 ADMIN 角色才可调用成功

返回

OK：成功
NO_PRIVILEGE: 没有权限
Others: 失败

注解: 此接口只有 ADMIN 角色才可调用

◆ clearUserContents()

virtual QResult PanoAnnotation::clearUserContents ( uint64_t userId )

pure virtual

清除指定用户标注内容

参数

userId 用户ID

返回

OK：成功
NO_PRIVILEGE: 没有权限
Others: 失败

注解: 只有 ADMIN 角色才可以清除非本地用户的内容

◆ getToolType()

virtual WBToolType PanoAnnotation::getToolType ( )

pure virtual

获取工具类型

返回

工具类型

◆ redo()

virtual QResult PanoAnnotation::redo ( )

pure virtual

重做标注的上一次被撤销操作

返回

OK：成功
Others: 失败

◆ removeToolboxView()

virtual QResult PanoAnnotation::removeToolboxView ( void * window )

pure virtual

移除工具栏窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

◆ setAspectSize()

virtual QResult PanoAnnotation::setAspectSize	(	int32_t	w,
		int32_t	h
	)

pure virtual

设置标注区域大小

参数

w	宽
h	高

返回

OK：成功
Others: 失败

◆ setColor()

virtual QResult PanoAnnotation::setColor ( WBColor color )

pure virtual

设置颜色

参数

color 颜色

返回

OK：成功
Others: 失败

◆ setExtAnnoMode()

virtual QResult PanoAnnotation::setExtAnnoMode ( ExternalAnnoMode mode )

pure virtual

设置外部标注模式。仅对外部标注有效。

参数

mode	ExternalAnnoMode类别

返回

OK: 成功
其他: 失败

◆ setFillColor()

virtual QResult PanoAnnotation::setFillColor ( WBColor color )

pure virtual

设置填充颜色

参数

color 颜色。有效值范围：[0, 1]。

返回

OK：成功
Others: 失败

注解: 填充类型为WbFileType::COLOR时，此设置方能起效。

◆ setFillType()

virtual QResult PanoAnnotation::setFillType ( WBFillType type )

pure virtual

设置填充类型

参数

type 填充类型

返回

OK：成功
Others: 失败

◆ setFontSize()

virtual QResult PanoAnnotation::setFontSize ( int size )

pure virtual

设置字体大小

参数

size 字体大小

返回

OK：成功
Others: 失败

◆ setFontStyle()

virtual QResult PanoAnnotation::setFontStyle ( WBFontStyle style )

pure virtual

设置字体样式

参数

style 字体样式

返回

OK：成功
Others: 失败

◆ setLineWidth()

virtual QResult PanoAnnotation::setLineWidth ( int size )

pure virtual

设置线宽

参数

size	线宽。有效值范围 [1, 20]

返回

OK：成功
Others: 失败

◆ setOption()

virtual QResult PanoAnnotation::setOption	(	AnnoOption	option,
		void *	param,
		size_t	size
	)

pure virtual

设置标注参数

参数

option	参数类别
param	参数, 参数的定义需遵循不同的option所定义的参数结构
size	参数的大小

返回

OK: 成功
其他: 失败

◆ setRoleType()

virtual QResult PanoAnnotation::setRoleType ( WBRoleType type )

pure virtual

设置标注角色类型。

参数

type 标注角色。

◆ setScalingMode()

virtual QResult PanoAnnotation::setScalingMode ( WBScalingMode mode )

pure virtual

设置标注区域缩放模式

参数

mode 缩放模式

返回

OK：成功
Others: 失败

◆ setToolType()

virtual QResult PanoAnnotation::setToolType ( WBToolType type )

pure virtual

设置工具类型

参数

type 工具类型

返回

OK：成功
Others: 失败

◆ setVisible()

virtual QResult PanoAnnotation::setVisible ( bool visible )

pure virtual

设置标注视图是否可见

参数

visible 是否可见

返回

OK：成功
Others: 失败

注解: 标注视图默认是可见的

◆ setWindowPos()

virtual QResult PanoAnnotation::setWindowPos ( WBRect rect )

pure virtual

设置标注窗口位置及大小。

参数

rect WBRect类型

返回

OK: 成功
其他: 失败

◆ snapshot()

virtual QResult PanoAnnotation::snapshot ( const char * outputDir )

pure virtual

保存标注内容到图像。

参数

outputDir 输出路径

返回

OK：成功
Others: 失败

注解: 快照结果和图像文件名通过回调函数onSnapshotComplete返回

◆ startAnnotation()

virtual QResult PanoAnnotation::startAnnotation ( void * window )

pure virtual

开启标注并且设置显示窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

注解

开启标注前需要保证白板服务是正常的。
对共享标注的共享端，window参数传NULL

◆ stopAnnotation()

virtual QResult PanoAnnotation::stopAnnotation ( )

pure virtual

停止标注

返回

OK：成功
Others: 失败

◆ undo()

virtual QResult PanoAnnotation::undo ( )

pure virtual

撤消上一次操作

返回

OK：成功
Others: 失败

该类的文档由以下文件生成:

PanoAnnotation.h

类

Public 成员函数

Protected 成员函数

详细描述

成员函数说明

◆ addToolboxView()

◆ clearContents()

◆ clearUserContents()

◆ getToolType()

◆ redo()

◆ removeToolboxView()

◆ setAspectSize()

◆ setColor()

◆ setExtAnnoMode()

◆ setFillColor()

◆ setFillType()

◆ setFontSize()

◆ setFontStyle()

◆ setLineWidth()

◆ setOption()

◆ setRoleType()

◆ setScalingMode()

◆ setToolType()

◆ setVisible()

◆ setWindowPos()

◆ snapshot()

◆ startAnnotation()

◆ stopAnnotation()

◆ undo()