扫一扫咨询方案
首页
登录/注册

{user.username}

ID: {user.id}

模板 SDK 文档

  • 云渲染

    • Demo下载
    • SDK
    • 开发指南
    • AI API 文档
    • 开发者 API 文档
    • 控制台指南
    • 快速入门
    • 产品简介
  • 模板SDK

    • 用户常见问题
    • Demo 下载
    • 开发指南
    • 服务端 SDK
    • iOS SDK
    • 安卓端 SDK
    • 产品简介
  • 剪辑SDK

    • Demo下载
    • SDK
    • 开发指南
    • 产品简介
  • 模板制作教程

    • 模板制作进阶教程
    • 测试模板素材案例下载
    • 常见模板制作案例
    • 模板制作教程
    • 模板制作工具下载
    • 入门指南
  • 剪辑制作教程

    • 剪辑特效导出教程
    • 剪辑特效测试素材
    • 剪辑特效制作工具下载
    • 入门指南
产品简介
安卓端 SDK
iOS SDK
服务端 SDK
开发指南
Demo 下载
用户常见问题
首页 > iOS SDK > 常用 API > SXTextCanvas 接口

SXTextCanvas 接口

更新时间 : 2021-07-21 14:22:28

SXTextCanvas 接口

/**
* 文字对齐方式
*/
typedef enum : NSUInteger {
    SXTextCanvasAlignmentLeft,      // 左对齐
    SXTextCanvasAlignmentRight,     // 右对齐
    SXTextCanvasAlignmentCenter,    // 居中对齐
} SXTextCanvasAlignment;

/**
* 文字换行方式
*/
typedef enum : NSUInteger {
    SXLineBreakByWordWrapping,
    SXLineBreakByCharWrapping,
    SXLineBreakByClipping,
    SXLineBreakByTruncatingHead,
    SXLineBreakByTruncatingTail,
    SXLineBreakByTruncatingMiddle
} SXLineBreak;

/**
* 文字画板,通过读取VE模板文字素材配置信息绘制生成文字图片文件
*/
@interface SXTextCanvas : NSObject

/**
* 读取和设置文字输入框范围
*/
@property (nonatomic, assign) CGRect area;

/**
* 读取和设置画布大小
*/
@property (nonatomic, assign) CGSize canvasSize;

/**
* 读取和设置字体大小
*/
@property (nonatomic, assign) int fontSize;

/**
* 当前字体样式
*/
@property (nonatomic, copy)   NSString *font;

/**
* 读取和设置文字填充颜色
*/
@property (nonatomic, strong) UIColor *fillColor;

/**
* 读取和设置文字描边颜色
*/
@property (nonatomic, strong) UIColor *strokeColor;

/**
* 读取和设置文字描边大小
*/
@property (nonatomic, assign) int strokeWidth;

/**
* 读取和设置要绘制的文字内容
*/
@property (nonatomic, copy)   NSString *content;

/**
* 读取和设置文字对齐方式
*/
@property (nonatomic, assign) SXTextCanvasAlignment alignment;

/**
* 读取和设置文字换行方式
*/
@property (nonatomic, assign) SXLineBreak lineBreak;

/**
*    创建一个文字画板对象
* @param dictionary 文字样式配置数据,格式为config.json文字素材的配置格式
* @return 实例
*/
- (instancetype)initWithDictionary:(NSDictionary *)dictionary;

/**
* 根据用户设置的文字内容,字体样式和输入框范围调节字号大小来使文字完整显示出来
*/
- (void)adjustSize;

/**
* 保存结果到文件
* @param path png文件路径
*/
- (void)saveToPath:(NSString *)path;

/**
* 根据导出文件中ui的数据结构配置画出文字图片
* @param jsonStrig json字符串
* @param fontPath 字体
* @return 图片数据
*/
+ (UIImage *)drawImage:(NSString *)jsonStrig fontPath:(NSString *)fontPath offset:(CGPoint *)offset;
@end
首页 > iOS SDK > 常用 API > SXTextCanvas 接口
SXTextCanvas 接口
更新时间 : 2021-07-21 14:22:28
  • 云渲染
    • Demo下载
    • SDK
    • 开发指南
    • AI API 文档
    • 开发者 API 文档
    • 控制台指南
    • 快速入门
    • 产品简介
  • 模板SDK
    • 用户常见问题
    • Demo 下载
    • 开发指南
    • 服务端 SDK
    • iOS SDK
    • 安卓端 SDK
    • 产品简介
  • 剪辑SDK
    • Demo下载
    • SDK
    • 开发指南
    • 产品简介
  • 模板制作教程
    • 模板制作进阶教程
    • 测试模板素材案例下载
    • 常见模板制作案例
    • 模板制作教程
    • 模板制作工具下载
    • 入门指南
  • 剪辑制作教程
    • 剪辑特效导出教程
    • 剪辑特效测试素材
    • 剪辑特效制作工具下载
    • 入门指南

SXTextCanvas 接口

/**
* 文字对齐方式
*/
typedef enum : NSUInteger {
    SXTextCanvasAlignmentLeft,      // 左对齐
    SXTextCanvasAlignmentRight,     // 右对齐
    SXTextCanvasAlignmentCenter,    // 居中对齐
} SXTextCanvasAlignment;

/**
* 文字换行方式
*/
typedef enum : NSUInteger {
    SXLineBreakByWordWrapping,
    SXLineBreakByCharWrapping,
    SXLineBreakByClipping,
    SXLineBreakByTruncatingHead,
    SXLineBreakByTruncatingTail,
    SXLineBreakByTruncatingMiddle
} SXLineBreak;

/**
* 文字画板,通过读取VE模板文字素材配置信息绘制生成文字图片文件
*/
@interface SXTextCanvas : NSObject

/**
* 读取和设置文字输入框范围
*/
@property (nonatomic, assign) CGRect area;

/**
* 读取和设置画布大小
*/
@property (nonatomic, assign) CGSize canvasSize;

/**
* 读取和设置字体大小
*/
@property (nonatomic, assign) int fontSize;

/**
* 当前字体样式
*/
@property (nonatomic, copy)   NSString *font;

/**
* 读取和设置文字填充颜色
*/
@property (nonatomic, strong) UIColor *fillColor;

/**
* 读取和设置文字描边颜色
*/
@property (nonatomic, strong) UIColor *strokeColor;

/**
* 读取和设置文字描边大小
*/
@property (nonatomic, assign) int strokeWidth;

/**
* 读取和设置要绘制的文字内容
*/
@property (nonatomic, copy)   NSString *content;

/**
* 读取和设置文字对齐方式
*/
@property (nonatomic, assign) SXTextCanvasAlignment alignment;

/**
* 读取和设置文字换行方式
*/
@property (nonatomic, assign) SXLineBreak lineBreak;

/**
*    创建一个文字画板对象
* @param dictionary 文字样式配置数据,格式为config.json文字素材的配置格式
* @return 实例
*/
- (instancetype)initWithDictionary:(NSDictionary *)dictionary;

/**
* 根据用户设置的文字内容,字体样式和输入框范围调节字号大小来使文字完整显示出来
*/
- (void)adjustSize;

/**
* 保存结果到文件
* @param path png文件路径
*/
- (void)saveToPath:(NSString *)path;

/**
* 根据导出文件中ui的数据结构配置画出文字图片
* @param jsonStrig json字符串
* @param fontPath 字体
* @return 图片数据
*/
+ (UIImage *)drawImage:(NSString *)jsonStrig fontPath:(NSString *)fontPath offset:(CGPoint *)offset;
@end