概述
SViewBase for iOS 提供三维模型基本的浏览、模型属性操作、基本三维对象操作、动画播放、测量、批注等功能的实现接口,可实现基本的 三维模型展示功能,以便于用户个性化定制属于自己的产品。文档主要介绍了SViewBase控件提供的接口说明。
接口列表
参数配置
获取GLES版本号
接口
+ (int)getGLESVersion;
说明
获取GLES版本号
参数
无参数
返回值
int
备注
返回值为1时,openGLES版本为2;返回值为1时,openGLES版本为1。
设置app工作路径
接口
+ (void)setAppWorkPath:(NSString *)appWorkPath;
说明
设置app工作路径
参数
参数 | 是否必须 | 说明 |
---|---|---|
appWorkPath:外部设置的工作路径 | 是 | 外部设置的工作路径 |
返回值
void
备注
appWorkPath只能为沙盒路径,同时该路径是必须设置,否则会导致页面显示不全;该方法需要在SViewBase初始化之前设置
获取app工作路径
接口
+ (NSString *)getAppWorkPath;
说明
获取app工作路径
参数
无参数
返回值
NSString:返回的值即设置的工作路径
备注
无
设置授权码
接口
+ (void)setLicense:(NSString*)license;
说明
设置控件使用的授权码
参数
参数 | 是否必须 | 说明 |
---|---|---|
appWorkPath | 是 | 提供的授权码 |
返回值
void
备注
如果设置的授权码无效,则在打开文件时会弹出相关提示,如果授权码有效则会直接打开文件,没有弹窗提醒
设置是否显示坐标轴
接口
- (void)setShowAxis:(BOOL)show;
说明
在模型成功显示后,默认会在页面左下角显示三维坐标轴,如不需要,可通过该接口控制坐标轴的隐藏
参数
参数 | 是否必须 | 说明 |
---|---|---|
show | 是 | 显示/隐藏坐标轴(默认为YES) |
返回值
void
备注
无
设置是否显示PMI
接口
- (void)setShowPMI:(BOOL)isShowPMI;
说明
在模型成功显示后,默认不显示模型的PMI信息,可通过该接口控制PMI的显示或隐藏
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowPMI | 是 | 显示/隐藏PMI(默认为YES) |
返回值
void
备注
部分模型是带有PMI信息的,可以通过该接口控制是否显示PMI信息
设置使用Catia模式
接口
- (void)setUseCatiaMode:(BOOL)isUseCatiaMode;
说明
在模型成功显示后,默认不使用Catia模式,可通过该接口控制是否使用Catia模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
isUseCatiaMode | 是 | 开启/关闭Catia模式(默认为NO) |
返回值
void
备注
通过该接口可以开启或者关闭Catia模式,满足不同模型的不用需求
设置使用高性能模式
接口
- (void)setHighPerformanceView:(BOOL)isHighPerformanceView;
说明
在模型过大或者显示存在困顿现象时,可开启该配置,以优化显示,减少模型操作卡顿
参数
参数 | 是否必须 | 说明 |
---|---|---|
isHighPerformanceView | 是 | 开启/关闭高性能模式(默认为NO) |
返回值
void
备注
无
设置是否使用LOD
接口
- (void)setUseLOD:(BOOL)isUseLOD;
说明
设置是否使用LOD
参数
参数 | 是否必须 | 说明 |
---|---|---|
isUseLOD | 是 | 使用/不适用LOD(默认为NO) |
返回值
void
备注
无
设置使用天空盒
接口
- (void)setUseSkyBox:(BOOL)isUseSkyBox;
说明
设置是否使用天空盒模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
isUseSkyBox | 是 | 开启/关闭天空盒(默认为NO) |
返回值
void
备注
无
设置显示包围盒
接口
- (void)setShowModelBox:(BOOL)isShowModelBox;
说明
设置是否显示模型的包围盒
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowModelBox | 是 | 显示/关闭包围盒(默认为NO) |
返回值
void
备注
无
设置显示网格
接口
- (void)setShowModelBox:(BOOL)isShowModelBox;
说明
设置是否显示模型的网格
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowModelBox | 是 | 显示/关闭包围盒(默认为NO) |
返回值
void
备注
无
设置显示半透明
接口
- (void)setShowTransparent:(BOOL)isShowTransparent;
说明
设置模型为半透明显示
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowTransparent | 是 | 模型透明显示/不透明显示(默认为NO) |
返回值
void
备注
设置整个模型为半透明显示
设置显示边界线
接口
- (void)setShowModelEdge:(BOOL)isShowModelEdge;
说明
设置显示边界线
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowModelEdge | 是 | 显示/不显示边界线(默认为NO) |
返回值
void
备注
无
设置显示边界线
接口
- (void)setShowModelEdge:(BOOL)isShowModelEdge;
说明
设置显示边界线
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowModelEdge | 是 | 显示/不显示边界线(默认为NO) |
返回值
void
备注
无
设置微小模型剔除方式
接口
- (void)setRemoveMode:(int)mode;
说明
设置微小模型剔除方式,包括模型和屏幕
参数
参数 | 是否必须 | 说明 |
---|---|---|
mode | 是 | 设置微小模型剔除方式为模型/屏幕(默认为模型) |
返回值
void
备注
无
设置微小模型剔除比例
接口
- (void)setRemoveSize:(int)size;
说明
设置微小模型剔除比例
参数
参数 | 是否必须 | 说明 |
---|---|---|
size | 是 | size值:0~100设置微小模型剔除方式为模型/屏幕 |
返回值
void
备注
无
设置灯光模式
接口
- (void)setLightingMode:(int)mode;
说明
设置灯光模式,包括人物、珠宝等灯光效果
参数
参数 | 是否必须 | 说明 |
---|---|---|
mode | 是 | 0:普通 1:人物 200:珠宝400:环境映射 500:牙齿 600:插画 |
返回值
void
备注
无
设置语言国际化
接口
- (void)setInternationalLanguage:(int)mode;
说明
设置文字显示类型
参数
参数 | 是否必须 | 说明 |
---|---|---|
mode | 是 | 0:中文 1:英文 |
返回值
void
备注
通过该接口可以设置批注等文字显示的语言为中文或者英文
基本操作
打开本地文件
接口
- (void)openFile:(NSString *)filePath;
说明
打开一个本地文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 本地文件路径 |
返回值
void
备注
需要确保filePath不能为空
打开文件集
接口
-(BOOL) openFiles:(NSArray *)filePaths
说明
同时打开多多个文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePaths | 是 | 存放多个文件路径 |
返回值
BOOL:是否成功打开文件
备注
需要确保filePaths内存放的路径存在,并且不为空
关闭当前文件
接口
-(void)closeFile;
说明
同时打开多多个文件
参数
无参数
返回值
void
备注
关闭已经打开的文件;在释放SViewBase对象时,需要此接口关闭文件
保存当前模型文件
接口
-(void) saveFile:(NSString*) tarFilePath;
说明
同时打开多多个文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
tarFilePath | 是 | 文件保存之后存放的位置 |
返回值
void
备注
调用该接口可以将已经打开的模型文件保存到指定位置
复位模型
接口
-(void) restoreView;
说明
复位模型,恢复到打开状态
参数
无参数
返回值
void
备注
如果模型内的零件删除后,不能通过复位操作来恢复已删除零件
执行刷新操作
接口
- (void)requestDraw;
说明
刷新页面
参数
无参数
返回值
void
备注
无
获取顶级模型
接口
-(SModel*) getRootModel;
说明
获取已打开模型的顶级SModel对象
参数
无参数
返回值
SModel:顶级SModel对象
获取模型的顶级SModel对象
无
获取选择器
接口
-(SSelector*)getSSelecter;
说明
获取选择器,选择器内存放的是已选中的模型,或者将模型加入选择器可以改变模型选中状态
参数
无参数
返回值
SSelector:选择器对象
获取选择器对象,方便获得已选中的SModel
无
设置模型的可见性
接口
-(void) setVisible:(BOOL)visible;
说明
设置模型的可见性
参数
参数 | 是否必须 | 说明 |
---|---|---|
visible | 是 | 显示/隐藏模型 |
返回值
void
备注
设置模型的可见性。即显示或者隐藏
选中/取消选中模型
接口
-(void)setSelected:(BOOL)select
说明
选中或者取消选中模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
select | 是 | 选中/取消选中模型 |
返回值
void
备注
设置模型的选中状态,如果模型的选中状态为YES,则该模型为红色;如果选中状态为NO,则模型颜色为默认颜色
截图
接口
- (UIImage*)takeSnapshot;- (UIImage*)takeSnapshot:(CGSize)newSize;
说明
提供两种截图方法,一种带参数,一种不带参数。带参数返回的图片size为指定的大小,不带参数返回的图片size为sviewBase的大小
参数
参数 | 是否必须 | 说明 |
---|---|---|
newSize | 是 | 生成图片的大小 |
返回值
void
备注
无
是否自动制定旋转中心点
接口
-(BOOL)isAutoSelectRotateCenter;
说明
获取当前是否自动指定旋转中心点
参数
无参数
返回值
BOOL
当自动指定旋转中心点为YES时,只有模型放到到一定倍数的情况下才会有效
无
设置自动选择旋转中心
接口
-(void) setAutoSelectRotateCenter:(BOOL)autoSelect;
说明
设置自动选择旋转中心
参数
参数 | 是否必须 | 说明 |
---|---|---|
autoSelect | 是 | 自动选择/固定旋转中心 |
返回值
void
备注
当自动指定旋转中心点为YES时,只有模型放到到一定倍数的情况下才会有效
自动旋转
接口
- (void)startRotateOnSpeed:(float)speed;
说明
设置自动旋转
参数
参数 | 是否必须 | 说明 |
---|---|---|
speed | 是 | 旋转速度 |
返回值
void
备注
设置模型自动旋转
停止旋转
接口
-(void) stopRotate;
说明
在模型自动旋转时,调用该接口可以停止旋转
参数
无参数
返回值
void
备注
在模型自动旋转时,调用该接口可以停止旋转
设置多选
接口
- (void)setAllowMultiSel:(BOOL)isAllow;
说明
设置多选
参数
参数 | 是否必须 | 说明 |
---|---|---|
isAllow | 是 | 可以多选/只能单选 |
返回值
void
备注
多选时可以同时选中两个或者两个以上的模型零件单选是每次只能选择一个,如果之前已有选择的模型零件,选择另一个模型零件,会取消之前模型零件的选中状态
获取允许多选
接口
- (BOOL)isAllowMultiSel;
说明
获取当前是否允许多选
参数
无参数
返回值
BOOL:允许多选/不允许多选
备注
获取当前是否允许多选
装配树匹配模型
接口
- (void)assembleSelectedShape:(int)shapeId;
说明
装配树匹配模型,可设置模型零件的选中状态为YES/NO
参数
参数 | 是否必须 | 说明 |
---|---|---|
shapeId | 是 | shape对象ID号 |
返回值
void
备注
如果以匹配到的模型已选中则会取消选中效果,如果未选中则会添加选中效果
页面设置
开始/暂停页面刷新
接口
-(void) setGLViewRefresh:(BOOL)isRefresh;
说明
开始/暂停页面的刷新
参数
参数 | 是否必须 | 说明 |
---|---|---|
isRefresh | 是 | 开始/暂停刷新页面 |
返回值
void
备注
在打开文件成功之后,会自动调用该接口。在页面隐藏或者程序进入后台之厚,需要设置暂停刷新页面
设置背景色
接口
-(void)setBackgroundColor:(float*)topColor bottomColor:(float*)color colorNum:(int)num
说明
设置模型展示页面的背景颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
topColor | 是 | 页面顶部颜色 |
color | 是 | 页面底部颜色 |
num | 是 | 3/4:RGB/RGBA |
返回值
void
备注
设置页面背景色,该背景色具有渐变效果
获取背景色
接口
-(void)getBackgroundColor:(float*)topColor bottomColor:(float*)color colorNum:(int)num
说明
获取当前模型展示页面的背景色
参数
参数 | 是否必须 | 说明 |
---|---|---|
topColor | 是 | 页面顶部颜色指针 |
color | 是 | 页面底部颜色指针 |
num | 是 | 3/4:RGB/RGBA |
返回值
void
备注
在调用之前需要创建3个指针,传入方法,调用该方法后,即可获取当前颜色
是否使用背景图片
接口
-(void)setBackgroundUseImage:(BOOL)isUse
说明
设置是否使用背景图片
参数
参数 | 是否必须 | 说明 |
---|---|---|
isUse | 是 | 使用/不使用背景图片 |
返回值
void
备注
设置是否使用背景图片,设置使用背景图片,则不显示背景色,反之显示背景色
设置背景图片
接口
-(void)setBackgroundImage:(NSString*)imagePath mappingStyle:(int)mappingStyle
说明
设置背景图片
参数
参数 | 是否必须 | 说明 |
---|---|---|
imagePath | 是 | 背景图片路径 |
mappingStyle | 是 | 背景图片映射方式(一般设置为0) |
返回值
void
备注
设置背景图片,确保imagePath不为空
手势配置
设置手势类型
接口
- (void)setGestureMode:(SVIEWBASEGESTUREMODE_MASK)type
说明
设置手势类型
参数
参数 | 是否必须 | 说明 |
---|---|---|
type | 是 | 手势类型枚举,包括普通、选择多拽、选择复位、单指移动、单指缩放、选择以及选中居中等类型 |
返回值
void
备注
设置手势的类型
获取当前手势类型
接口
- (SVIEWBASEGESTUREMODE_MASK) getGestureMode
说明
获取当前的手势类型
参数
无参数
返回值
SVIEWBASEGESTUREMODE_MASK:包括普通、选择多拽、选择复位、单指移动、单指缩放、选择以及选中居中等类型
备注
获取当前的手势类型
恢复正常手势操作
接口
- (void)defaultGestureMode
说明
恢复正常手势操作
参数
无参数
返回值
void
备注
恢复正常手势操作
处理单击操作
接口
- (void)onClicked:(CGPoint)point sviewBase:(SViewBase *)sviewBase;
说明
处理单击操作
参数
参数 | 是否必须 | 说明 |
---|---|---|
point | 是 | 内部传出的点击的点 |
sviewBase | 是 | 操作的对象 |
返回值
void
备注
该方法为SViewBase的代理方法
处理双击操作
接口
- (void)onDoubleClicked:(CGPoint)point sviewBase:(SViewBase *)sviewBase
说明
处理双击操作
参数
参数 | 是否必须 | 说明 |
---|---|---|
point | 是 | 内部传出的点击的点 |
sviewBase | 是 | 操作的对象 |
返回值
void
备注
该方法为SViewBase的代理方法
处理点击操作
接口
- (BOOL)onTouchEvent:(SMotionEvent*)event sviewBase:(SViewBase *)sviewBase
说明
处理点击操作
参数
参数 | 是否必须 | 说明 |
---|---|---|
point | 是 | 内部传出的点击的点 |
sviewBase | 是 | 操作的对象 |
返回值
BOOL
备注
该方法为SViewBase的代理方法
模型属性
拾取操作
接口
-(int) selectShape:(float)x touchY:(float)y;-(int)selectShape:(float)x screenY:(float)y shapeType:(int)shapeType geoType:(int)geoType;
说明
根据代理方法穿出的point点,传递到该方法内可以获取拾取对象的ID
参数
参数 | 是否必须 | 说明 |
---|---|---|
x | 是 | 拾取屏幕点的横坐标 |
y | 是 | 拾取屏幕点的纵坐标 |
shapeType | 是 | 拾取对象类型 |
geoType | 是 | 几何类型 |
返回值
int :拾取对象的ID
备注
如果返回的值为-1,在没有拾取到对象
模型移动(动画)
接口
-(void)moveOffShape:(SShape*)shape position:(SVector2)screentPnt;
说明
根据传入的点和shape对象,将shape对象对应的模型以动画形式移动到指定点
参数
参数 | 是否必须 | 说明 |
---|---|---|
shape | 是 | 需要移动的模型对象 |
screentPnt | 是 | 移动的目标位置 |
返回值
void
备注
将模型已动画移动的方式移动到指定点
模型恢复初始位置(动画)
接口
-(void)moveBackShape:(SShape*)shape
说明
模型以动画形式移动到初始位置
参数
参数 | 是否必须 | 说明 |
---|---|---|
shape | 是 | 需要移动的模型对象 |
screentPnt | 是 | 移动的目标位置 |
返回值
void
备注
模型以动画形式移动到初始位置
当前着色模式
接口
-(int)getDrawMode
说明
获取当前的着色模式
参数
无参数
返回值
int: 0:实体显示 1:表示线框模式 2:表示线框和实体同时显示
备注
获取当前的着色模式
获取选择模型数量
接口
-(int) getSelectedCount
说明
获取选择模型数量
参数
无参数
返回值
int: 选择模型的个数
备注
获取选择模型数量
改变选中模型颜色
接口
-(void) changeSelectedShapeColor:(float*)color colorNumber:(int)num
说明
改变模型颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
color | 是 | 颜色值 |
num | 是 | 颜色位数,RGB为3 RGBA为4 |
返回值
void
备注
无
设置模型颜色
接口
-(void)setShapeColor:(int)shapeId color:(float*)color colorNum:(int)num
说明
设置模型颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
shapeId | 是 | shape对象的ID号 |
color | 是 | 颜色值 |
num | 是 | 颜色位数,RGB为3 RGBA为4 |
返回值
void
备注
设置根据shaoeID对应Shape对象的颜色,num表示颜色位数,RGB为3,RGBA为4
获取模型颜色
接口
-(void)getShapeColor:(int)shapeId color:(float*)color colorNum:(int)num;
说明
获取指定模型的颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
shapeId | 是 | shape对象的ID号 |
color | 是 | 颜色值 |
num | 是 | 颜色位数,RGB为3 RGBA为4 |
返回值
void
备注
获取由shapeId指定对象的颜色,num表示颜色位数,RGB为3 RGBA为4
设置默认模型方向
接口
-(void) setDefaultModelDirection:(ModelDirection) direction;
说明
设置模型默认的的方向
参数
参数 | 是否必须 | 说明 |
---|---|---|
direction | 是 | 模型方向,包括上、下、左、右、前、后 |
返回值
void
备注
设置模型默认的的方向
复位选中模型
接口
-(void)restoreSelectedModel
说明
设置模型默认的的方向
参数
无参数
返回值
void
备注
复位选中模型, 需要先选中需要复位的模型,然后在调用该接口
显示、隐藏选中模型
接口
-(void)exchangHideAndShow
说明
隐藏或者显示选中的模型
参数
无参数
返回值
void
备注
隐藏或者显示选中的模型, 需要先选中需要复位的模型,然后在调用该接口
半透明选择模型
接口
-(void)transparentSelected
说明
设置选中的模型半透明
参数
无参数
返回值
void
备注
如果模型已经是半透明状态,调用该接口可设置选中模型为非半透明
模型资源路径
接口
-(NSArray*)getAllSrcFiles
说明
获取模型的相关资源路径
参数
无参数
返回值
NSArray:存放的是模型的相关资源路径
备注
调用该接口可以获得当前模型相关的资源路径
重设模型的随机色
接口
-(void) resetAllModelRandomColor
说明
重新设置模型内每个小模型的颜色,随机生成
参数
无参数
返回值
void
备注
调用该接口可以随机重新设置模型的颜色
模型恢复初始颜色
接口
-(void) restoreInitialColor
说明
恢复选中模型的初始颜色
参数
无参数
返回值
void
备注
调用该接口可以恢复选中模型的初始颜色,前提为选中该模型
隐藏选择模型
接口
-(void) hideSelected
说明
隐藏选中的模型
参数
无参数
返回值
void
备注
调用该接口可以隐藏选中的模型
显示隐藏模型
接口
- (void)showSelected
说明
显示选中的模型
参数
无参数
返回值
void
备注
调用该接口可以显示已选中的模型,如无法手动选择,可将对象的shape对象添加到选择器
设置默认观察模式
接口
-(void)setDefaultOrbitMode:(SVIEW_CONSTRAINT_MODE)defaultOrbitMode;
说明
设置默认的观察模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
defaultOrbitMode | 是 | 0:自由观察 1:动态观察 2:约束观察 |
返回值
void
备注
调用该接口可以设置默认的观察模式
获取默认观察模式
接口
- (SVIEW_CONSTRAINT_MODE)getDefaultOrbitMode;
说明
获取默认的观察模式
参数
无参数
返回值
defaultOrbitMode: 0:自由观察 1:动态观察 2:约束观察
备注
调用该接口可以获取当前默认的观察模式
设置观察模式
接口
- (void)setOrbitMode:(SVIEW_CONSTRAINT_MODE)orbitMode;
说明
设置观察模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
orbitMode | 是 | 0:自由观察 1:动态观察 2:约束观察 |
返回值
void
备注
调用该接口可以设置当前默认的观察模式
获取默认模型方向
接口
-(ModelDirection) getDefaultModelDirection;
说明
获取模型默认的的方向
参数
无参数
返回值
ModelDirection: 模型方向,包括上、下、左、右、前、后
备注
获取模型默认的的方向
设置着色模式
接口
-(void)setDrawMode:(int)modeId;
说明
设置模型当前的着色模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
modeId | 是 | 0:实体显示 1:表示线框模式 2:表示线框和实体同时显示 |
返回值
void
备注
设置模型当前的着色模式
获取复位的模型数量
接口
-(void) getAllInitPosModel:(int*) initedModelCount allModelCount:(int*) allModelCount;
说明
获取目前复位的模型数量
参数
参数 | 是否必须 | 说明 |
---|---|---|
initedModelCount | 是 | 已复位的属相 |
allModelCount | 是 | 所有的模型数量 |
返回值
void
备注
设置模型当前的着色模式
模型操作
插入模型
接口
-(BOOL) insert:(NSString*)filePath To:(SModel*)parentModel RetModel:(SModel*)retModel;
说明
打开指定文件路径的模型,将模型加入到parentModel下子模型点最后位置,并传出新模型指针
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 插入模型的文件路径 |
parentModel | 是 | 父节点对象 |
retModel | 是 | 新模型对象 |
返回值
BOOL:成功/失败
备注
打开指定文件路径的模型,将模型加入到parentModel下子模型点最后位置,并传出新模型指针a
复制插入模型
接口
- (BOOL)copy:(SModel *)model To:(SModel*)parentModel NewModel:(SModel*)newModel;
说明
将model复制到parentModel下子模型最后一个位置
参数
参数 | 是否必须 | 说明 |
---|---|---|
model | 是 | 复制的模型对象 |
parentModel | 是 | 父节点对象 |
retModel | 是 | 新模型对象 |
返回值
BOOL:成功/失败
备注
将model复制到parentModel下子模型最后一个位置
移动模型
接口
- (BOOL)move:(SModel*)model To:(SModel*)parentModel;
说明
将model移动到parentModel下子模型点最后一个位置
参数
参数 | 是否必须 | 说明 |
---|---|---|
model | 是 | 移动的模型对象 |
parentModel | 是 | 父节点对象 |
返回值
BOOL:成功/失败
备注
将model移动到parentModel下子模型点最后一个位置
重命名模型
接口
- (BOOL)reName:(NSString*)name Model:(SModel*)model;
说明
重命名模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
model | 是 | 需要重命名的模型对象 |
name | 是 | 新名字 |
返回值
BOOL:成功/失败
备注
重命名模型
删除模型
接口
- (BOOL)remove:(SModel *) model;
说明
删除模型节点
参数
参数 | 是否必须 | 说明 |
---|---|---|
model | 是 | 需要删除的模型对象 |
返回值
BOOL:成功/失败
备注
删除模型节点
视图浏览
设置透视图方向
接口
- (BOOL)remove:(SModel *) model;
说明
删除模型节点
参数
参数 | 是否必须 | 说明 |
---|---|---|
direction | 是 | 前视图、后视图、左视图、右视图、顶视图、底视图 |
返回值
void
备注
设置透视图方向
设置默认透视图方向
接口
-(void) setDefaultPerspective:(PerspectiveDirection) direction;
说明
设置默认透视图方向
参数
参数 | 是否必须 | 说明 |
---|---|---|
direction | 是 | 前视图、后视图、左视图、右视图、顶视图、底视图 |
返回值
void
备注
设置默认透视图方向
获取默认透视图方向
接口
-(PerspectiveDirection) getDefaultPerspective;
说明
获取默认透视图方向
参数
无参数
返回值
PerspectiveDirection:前视图、后视图、左视图、右视图、顶视图、底视图
备注
获取默认透视图方向
保存视图
接口
-(int) saveView
说明
保存当前视图
参数
无参数
返回值
int:返回的视图ID
备注
保存当前视图
恢复视图
接口
-(BOOL) resetViewWithID:(int)viewId;
说明
恢复到某个视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewId | 是 | 视图ID号 |
返回值
BOOL:恢复是否成功
备注
恢复到某个视图
批注操作
文本批注显示作者
接口
- (void)setTextNoteStyle:(int)style
说明
文本批注显示作者
参数
参数 | 是否必须 | 说明 |
---|---|---|
style | 是 | 0:不显示 1:显示作者 |
返回值
void
备注
设置文本批注是否显示作者
获取点对象
接口
- (int)getMeasurePointX:(float)_x withY:(float)_y isFeature:(BOOL) isFeature;
说明
获取点对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
isFeature | 是 | 是否是特征点 |
返回值
int:对象ID
备注
无
获取线对象
接口
- (int)getMeasureLineX:(float)_x withY:(float)_y;
说明
获取线对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取孔对象
接口
- (int)getMeasureArcX:(float)_x withY:(float)_y;
说明
获取孔对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取面对象
接口
- (int)getMeasureFaceX:(float)_x withY:(float)_y;
说明
获取面对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取模型对象
接口
- (int)getMeasureModelX:(float)_x withY:(float)_y;
说明
获取模型对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取序号批注对象
接口
- (int)getSequeceNoteX:(float)_x withY:(float)_y;
说明
获取序号批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取文本批注对象
接口
- (int)getTextNoteX:(float)_x withY:(float)_y;
说明
获取文本批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取声音批注对象
接口
- (int)getVoiceNoteX:(float)_x withY:(float)_y;
说明
获取声音批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取编辑对象
接口
- (int)getEditX:(float)_x withY:(float)_y;
说明
获取编辑对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
_x | 是 | 屏幕点的x值 |
_y | 是 | 屏幕点的y值 |
返回值
int:对象ID
备注
无
获取根模型属性
接口
- (NSArray*)getRootModelProperty;
说明
获取根模型属性
参数
无参数
返回值
NSArray:返回的属性
备注
无
获取测量对象属性
接口
- (NSString*)getPropertyMeasureWithMeasureId:(int)measureId measureType:(int)measureType;
说明
获取测量对象属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
measureId | 是 | 测量对象ID |
measureType | 是 | 测量对象类型 |
返回值
NSString:返回的属性
备注
无
设置语音批注对象数据
接口
- (void)setVoiceNoteOnFinishRecord:(int)voiceNoteId VoiceData:(NSString*)voiceData
说明
设置语音批注对象数据
参数
参数 | 是否必须 | 说明 |
---|---|---|
voiceNoteId | 是 | 语音批注对象ID |
voiceData | 是 | 语音批注对象数据 |
返回值
void
备注
无
切换视图时处理序号批注对象
接口
- (int)sequenceNoteWithXMLWhenChangeModelView:(NSString*)xmlString;
说明
切换视图时处理序号批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
xmlString | 是 | 批注对象xml内容串 |
返回值
int:序号对象ID
备注
无
切换视图时处理语音批注对象
接口
- (int)voiceNoteWithXMLWhenChangeModelView:(NSString*)xmlString;
说明
切换视图时处理语音批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
xmlString | 是 | 批注对象xml内容串 |
返回值
int:语音批注对象ID
备注
无
切换视图时处理文本批注对象
接口
- (int)textNoteWithXMLWhenChangeModelView:(NSString*)xmlString;
说明
切换视图时处理文本批注对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
xmlString | 是 | 批注对象xml内容串 |
返回值
int:文本批注对象ID
备注
无
序号编辑
接口
-(void)onSequenceEditNote:(SShape*)sshape TextValue:(NSString*)text;
说明
对序号对象进行编辑
参数
参数 | 是否必须 | 说明 |
---|---|---|
sshape | 是 | 序号对象 |
text | 是 | 修改后的序号内容 |
返回值
void
备注
无
创建序号标注
接口
- (int)createSequenceNote:(NSString*)sequenceNoteStr;
说明
创建序号批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
sequenceNoteStr | 是 | 序号批注内容 |
返回值
int: 序号批注对象的ID
备注
无
创建文本标注
接口
- (int)createTextNote:(NSString*)textNoteStr;
说明
创建文本标注
参数
参数 | 是否必须 | 说明 |
---|---|---|
textNoteStr | 是 | 文本批注内容 |
返回值
int: 文本批注对象的ID
备注
无
创建语音批注
接口
- (int)createVoiceNote:(NSString*)voiceNoteStr;
说明
创建语音批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
voiceNoteStr | 是 | 语音批注文件路径 |
返回值
int: 语音批注对象的ID
备注
无
获取语音流
接口
- (NSString*)getVoiceData:(int)voiceNoteId;
说明
获取语音流
参数
参数 | 是否必须 | 说明 |
---|---|---|
voiceNoteId | 是 | 语音批注对象ID号 |
返回值
NSString: 语音批注文件路径
备注
无
获取Note属性
接口
- (NSString*)getProperty:(SShape*)note PropertyType:(NSString*)pType;
说明
获取Note属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
note | 是 | note对象 |
pType | 是 | 属性类型 |
返回值
NSString: 属性内容
备注
无
转化数据流
接口
- (NSString*)noteToXMLElement:(SShape*)note;
说明
转化数据流
参数
参数 | 是否必须 | 说明 |
---|---|---|
note | 是 | note对象 |
返回值
NSString: 转化之后的数据流
备注
无
获取对象的TextValue
接口
- (NSString*)getNoteTextValue:(SShape*)sshape;
说明
获取对象的TextValue
参数
参数 | 是否必须 | 说明 |
---|---|---|
sshape | 是 | 需要获取textValue的对象 |
返回值
NSString: textValue值
备注
无
获取对象的guid
接口
- (NSString*)getNoteGuid:(SShape*)sshape;
说明
获取对象的guid
参数
参数 | 是否必须 | 说明 |
---|---|---|
sshape | 是 | 需要获取uuid的对象 |
返回值
NSString: uuid值
备注
无
创建距离测量对象
接口
- (int)createDistanceMeasureWithFirstShapeId:(int)firstShapeId secondShapeId:(int)secondShapeId firstPntId:(int)firstPntId secondPntId:(int)secondPntId nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y UserName:(NSString*)userName CreateTime:(NSString*)createTime Guid:(NSString*)guid;
说明
创建距离测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
firstShapeId | 是 | 第一个测量对象ID |
secondShapeId | 是 | 第二个测量对象ID |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成测量位置的x点 |
_y | 是 | 生成测量位置的y点 |
userName | 是 | 创建作者 |
createTime | 是 | 创建时间 |
guid | 是 | 创建者的唯一标示 |
firstPntId | 是 | 第一个点 |
secondPntId | 是 | 第二个点 |
返回值
int: 测量对象ID号
备注
无
创建属性测量对象
接口
- (int)createPropertyMeasureWithPropertyShapeId:(int)propertyShapeId nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y UserName:(NSString*)userName CreateTime:(NSString*)createTime Guid:(NSString*)guid;
说明
创建属性测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
propertyShapeId | 是 | 属性测量对象ID |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成测量位置的x点 |
_y | 是 | 生成测量位置的y点 |
userName | 是 | 创建作者 |
createTime | 是 | 创建时间 |
guid | 是 | 创建者的唯一标示 |
返回值
int: 测量对象ID号
备注
无
创建属性测量对象
接口
- (int)createAngleMeasureWithFirstShapeId:(int)firstShapeId secondShapeId:(int)secondShapeId nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y UserName:(NSString*)userName CreateTime:(NSString*)createTime Guid:(NSString*)guid;
说明
创建属性测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
firstShapeId | 是 | 第一个测量对象ID |
secondShapeId | 是 | 第二个测量对象ID |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成测量位置的x点 |
_y | 是 | 生成测量位置的y点 |
userName | 是 | 创建作者 |
createTime | 是 | 创建时间 |
guid | 是 | 创建者的唯一标示 |
返回值
int: 测量对象ID号
备注
无
创建序号批注对象
接口
- (int)createSequenceNumberNoteWithFirstShapeId:(int)firstShapeId withText:(NSString*)text nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y;
说明
创建属性测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
firstShapeId | 是 | 第一个序号对象ID |
text | 是 | 批注内容 |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成批注位置的x点 |
_y | 是 | 生成批注位置的y点 |
返回值
int: 批注对象ID号
备注
无
创建文本批注对象
接口
- (int)createTextNoteWithFirstShapeId:(int)firstShapeId withText:(NSString*)text nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y UserName:(NSString*)userName CreateTime:(NSString*)createTime Guid:(NSString*)guid;
说明
创建属性测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
firstShapeId | 是 | 第一个批注对象ID |
text | 是 | 批注内容 |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成批注位置的x点 |
_y | 是 | 生成批注位置的y点 |
userName | 是 | 创建作者 |
createTime | 是 | 创建时间 |
guid | 是 | 创建者的唯一标示 |
返回值
int: 批注对象ID号
备注
无
创建声音批注对象
接口
- (int)createVoiceNoteWithText:(NSString*)text nativeViewID:(int)nativeViewID withPointX:(float)_x withY:(float)_y UserName:(NSString*)userName CreateTime:(NSString*)createTime Guid:(NSString*)guid;
说明
创建属性测量对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
text | 是 | 语音文件路径 |
nativeViewID | 是 | 测量类型 |
_x | 是 | 生成批注位置的x点 |
_y | 是 | 生成批注位置的y点 |
userName | 是 | 创建作者 |
createTime | 是 | 创建时间 |
guid | 是 | 创建者的唯一标示 |
返回值
int: 批注对象ID号
备注
无
剖切
剖切
接口
-(void)setClipPlan:(int)direction Position:(float)position ShowClipPlan:(BOOL)isShowClipPlan ShowCutPlane:(BOOL)isShowCutPlane;
说明
基于坐标平面创建剖面,可调节剖切深度,展示剖切面内容
参数
参数 | 是否必须 | 说明 |
---|---|---|
direction | 是 | 方向 1:X;2:Y;3:Z; -1:-X;-2:-Y;-3:-Z |
position | 是 | 位置 0~100表示剖切百分比 |
isShowClipPlane | 是 | 是否显示示意面x点 |
isShowCutPlane | 是 | 是否显示盖面y点 |
返回值
void
备注
无
关闭剖切
接口
-(void)closeClipPlane;
说明
关闭模型的剖切展示
参数
无参数
返回值
void
备注
无
设置显示剖切
接口
- (void)setShowSection:(BOOL)isShowSection;
说明
设置显示剖切
参数
参数 | 是否必须 | 说明 |
---|---|---|
isShowSection | 是 | 显示/隐藏剖切 |
返回值
void
备注
无
爆炸图
爆炸图
接口
-(void)setExplosive:(int)style Position:(float)position useAnimation:(BOOL)isUseAnimation;
说明
展示模型爆炸效果
参数
参数 | 是否必须 | 说明 |
---|---|---|
style | 是 | 爆炸类型;0-远离中心点爆炸;1-左右爆炸;2-上下爆炸 |
pos | 是 | 爆炸间距0-100 |
返回值
void
备注
无
关闭爆炸图
接口
-(void)closeExplosive;
说明
关闭模型的爆炸展示
参数
无参数
返回值
void
备注
无
动画
播放
接口
-(BOOL) play;
说明
开始播放模型的动画文件
参数
无参数
返回值
BOOL:YES/NO 成功/失败
备注
无
暂停
接口
-(BOOL) pause;
说明
暂停模型动画文件的播放
参数
无参数
返回值
BOOL:YES/NO 成功/失败
备注
无
打开动画文件
接口
-(BOOL) open:(NSString*)filePath
说明
打开动画文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 模型文件路径 |
返回值
BOOL:YES/NO 成功/失败
备注
无
停止动画
接口
-(BOOL) stop;
说明
停止动画的播放
参数
参数 | 是否必须 | 说明 |
---|---|---|
filePath | 是 | 模型文件路径 |
返回值
BOOL:YES/NO 成功/失败
备注
无
是否有动画
接口
-(BOOL) isAnimation
说明
判断是否有动画
参数
无参数
返回值
BOOL: YES/NO: 有/无动画
备注
无
单段动画
接口
-(BOOL) isSingleAnimation
说明
判断是否是单端动画
参数
无参数
返回值
BOOL YES/NO:是/不是单端动画
备注
无
设置进度
接口
-(BOOL) setTick:(float)percent
说明
设置动画播放进度
参数
参数 | 是否必须 | 说明 |
---|---|---|
percent | 是 | 动画播放进度 |
返回值
BOOL YES/NO:设置成功/失败
备注
无
设置播放速度
接口
-(void) setPlaySpeed:(float)speed
说明
设置动画播放速度
参数
参数 | 是否必须 | 说明 |
---|---|---|
speed | 是 | 播放速度 |
返回值
void
备注
无
任务中的过程
接口
-(NSArray*)getTaskProcesss
说明
获取任务中所有过程
参数
无参数
返回值
NSArray:过程数组
备注
无
获取动画任务
接口
-(NSArray*)getTasks
说明
获取所有动画任务
参数
无参数
返回值
NSArray:动画任务数组
备注
无
自动漫游
接口
-(void) autoWalkCamera:(BOOL)isAuto
说明
在动画播放中开启自动漫游,场景会跟随动画的播放进行调整
参数
参数 | 是否必须 | 说明 |
---|---|---|
isAuto | 是 | YES/NO:开启/关闭漫游 |
返回值
void
备注
无
获取播放进度
接口
-(float) getTick
说明
获取动画播放的进度
参数
无参数
返回值
float:进度值
备注
无
是否正在播放
接口
-(BOOL) isPlaying
说明
是否正在播放
参数
无参数
返回值
BOOL:YES/NO:正在播放/暂停播放
备注
无
设置循环播放
接口
- (void)setLoopPlay:(BOOL)isLoop;
说明
设置循环播放
参数
参数 | 是否必须 | 说明 |
---|---|---|
isLoop | 是 | YES/NO:循环播放/不循环播放 |
返回值
void
备注
无