Foxit PDF SDK
FSImageObject类 参考
类 FSImageObject 继承关系图:
FSGraphicsObject

构造函数

(FSBitmap *) - cloneBitmap:
 
(FSBitmap *) - cloneBitmapWithPage:graphics_objects:
 从当前图像图形对象克隆位图。
更多...
 
(FSColorSpaceType) - getColorSpace
 获取颜色空间。
更多...
 
(FSPDFObject *) - getMask
 获取表示当前图像图形对象蒙版的PDF对象。
更多...
 
(FSPDFStream *) - getStream
 获取图像流。
更多...
 
(BOOL) - isImageMask
 检查当前图像对象是否被视为蒙版。
更多...
 
(void) - setBitmap:mask:
 将位图设置到当前图像图形对象。
更多...
 
(void) - setImage:frame_index:
 将图像的一帧设置到当前图像图形对象。
更多...
 
- 构造函数 继承自 FSGraphicsObject
(BOOL) - addClipPath:fill_mode:
 添加用于裁剪的路径。
更多...
 
(BOOL) - addClipTextObject:
 添加用于裁剪的文本对象。
更多...
 
(BOOL) - clearClips
 清除所有裁剪。
更多...
 
(FSGraphicsObject *) - clone
 克隆新的图形对象。
更多...
 
(FSGraphicsObject *) - cloneWithSrcGraphicsobjects:dest_graphicsobjects:
 克隆新的图形对象。
更多...
 
(FSPath *) - getClipPath:
 根据索引获取路径裁剪。
更多...
 
(int) - getClipPathCount
 获取路径裁剪的数量。
更多...
 
(FSFillMode) - getClipPathFillMode:
 根据索引获取路径裁剪的填充模式。
更多...
 
(FSTextObject *) - getClipTextObject:
 根据索引获取文本裁剪的文本对象。
更多...
 
(int) - getClipTextObjectCount
 获取文本裁剪的数量。
更多...
 
(FSFormXObject *) - getFormXObject
 如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。
更多...
 
(FSImageObject *) - getImageObject
 如果当前图形对象表示图像对象,则获取图像图形对象。
更多...
 
(FSLayerNodeArray *) - getLayers:
 获取与当前图形对象关联的所有图层。
更多...
 
(FSMarkedContent *) - getMarkedContent
 获取标记内容对象。
更多...
 
(FSPathObject *) - getPathObject
 如果当前图形对象表示路径对象,则获取路径图形对象。
更多...
 
(FSRectF *) - getRect
 获取当前图形对象的矩形。
更多...
 
(FSShadingObject *) - getShadingObject
 如果当前图形对象表示阴影对象,则获取阴影图形对象。
更多...
 
(FSTextObject *) - getTextObject
 如果当前图形对象表示文本对象,则获取文本图形对象。
更多...
 
(FSGraphicsObjectType) - getType
 获取当前图形对象的类型。
更多...
 
(BOOL) - hasTransparency
 检查当前图形对象是否具有透明度。
更多...
 
(BOOL) - removeClipPath:
 根据索引删除路径裁剪。
更多...
 
(BOOL) - removeClipTextObject:
 根据索引删除用于裁剪的文本裁剪。
更多...
 
(void) - rotate:
 从当前状态以指定的角度顺时针旋转当前图形对象。
更多...
 
(BOOL) - transform:need_transform_clippath:
 变换当前图形对象。
更多...
 

类方法

(FSImageObject *) + create:
 创建新的图像图形对象。
更多...
 
(FSImageObject *) + createFromType3TextObject:text_obj:
 从type3文本对象创建图像图形对象。
更多...
 

额外继承的成员函数

- 属性 继承自 FSGraphicsObject
FSGraphicsObjectBlendMode blendMode
 获取透明成像模型的混合模式。

 
FSRectF * clipRect
 获取裁剪矩形。

 
FSColorState * colorState
 获取颜色状态。
更多...
 
unsigned int fillColor
 获取填充颜色。
更多...
 
float fillOpacity
 获取除描边外的绘制操作的不透明度值。

 
FSGraphState * graphState
 获取图形状态。
更多...
 
FSMatrix2D * matrix
 获取矩阵。

 
unsigned int strokeColor
 获取描边颜色。
更多...
 
float strokeOpacity
 获取路径和字形轮廓的描边绘制操作的不透明度值。

 

详细描述

图像图形对象是一种PDF图形对象,因此类 FSImageObject 派生自 类 FSGraphicsObject 。它提供获取/设置图像图形对象数据的函数。
要创建新的图像图形对象,请使用函数 FSImageObject::create: ,然后 使用设置函数为新的图像图形对象设置信息。

参见
FSGraphicsObject

函数文档

◆ cloneBitmap:()

- (FSBitmap *) cloneBitmap: (FSGraphicsObjects*)  graphics_objects
弃用:
此函数已弃用。请使用带两个参数的函数 FSImageObject::cloneBitmap: 。

目前,只有当位图格式是以下格式之一时,才能从图像图形对象克隆位图:
FSBitmapDIB8bppMask 、 FSBitmapDIB8bpp 、 FSBitmapDIBRgb 、 FSBitmapDIBRgb32 、 FSBitmapDIBArgb 、 FSBitmapDIBCmyk 。
如果返回位图对象的函数 FSBitmap::isEmpty 的返回值为YES, 表示位图的DIB格式不受支持。

参数
[in]graphics_objects有效的 FSGraphicsObjects 对象。请确保当前图像图形对象 正好属于此 FSGraphicsObjects 对象(可能是PDF页面)。
返回
新克隆的位图对象。如果返回位图对象的函数 FSBitmap::isEmpty 的返回值为YES, 表示位图的DIB格式不受支持。

◆ cloneBitmapWithPage:graphics_objects:()

- (FSBitmap *) cloneBitmapWithPage: (FSPDFPage*)  page
graphics_objects: (FSGraphicsObjects*)  graphics_objects 

从当前图像图形对象克隆位图。

目前,只有当位图格式是以下格式之一时,才能从图像图形对象克隆位图:
FSBitmapDIB8bppMask 、 FSBitmapDIB8bpp 、 FSBitmapDIBRgb 、 FSBitmapDIBRgb32 、 FSBitmapDIBArgb 、 FSBitmapDIBCmyk 。
如果返回位图对象的函数 FSBitmap::isEmpty 的返回值为YES, 表示位图的DIB格式不受支持。

参数
[in]page有效的PDF页面对象。请确保当前图像图形对象正好属于此页面。
[in]graphics_objects有效的 FSGraphicsObjects 对象。请确保当前图像图形对象 正好属于此 FSGraphicsObjects 对象(可能是PDF页面)。
返回
新克隆的位图对象。如果返回位图对象的函数 FSBitmap::isEmpty 的返回值为YES, 表示位图的DIB格式不受支持。

◆ create:()

+ (FSImageObject *) create: (FSPDFDoc*)  document

创建新的图像图形对象。

新创建的图像图形对象还没有任何数据。然后,可以调用设置函数 为新的图像图形对象设置数据。 如果新创建的图像图形对象不会插入到任何页面或其他对象中, 请记住在不使用时调用函数 GraphicsObject::Release 来释放它。

参数
[in]document有效的PDF文档对象。然后新的图像图形对象应该插入到 此PDF文档的一个页面中。
返回
新的图像对象。如果有任何错误,此函数将返回nil。

◆ createFromType3TextObject:text_obj:()

+ (FSImageObject *) createFromType3TextObject: (FSPDFPage*)  page
text_obj: (FSTextObject*)  text_obj 

从type3文本对象创建图像图形对象。

如果新创建的图像图形对象不会插入到任何页面或其他对象中, 请记住在不使用时调用函数 GraphicsObject::Release 来释放它。

参数
[in]page有效的PDF页面对象。
[in]text_obj有效的文本对象。此文本对象应该是type3文本对象。
返回
新的图像对象。如果有任何错误,此函数将返回nil。

◆ getColorSpace()

- (FSColorSpaceType) getColorSpace

获取颜色空间。

返回
颜色空间。请参考从 FSColorSpaceDeviceGray 开始的值, 这将是这些值中的一个。

◆ getMask()

- (FSPDFObject *) getMask

获取表示当前图像图形对象蒙版的PDF对象。

蒙版可以是PDF字典或PDF数组:

  • PDF字典表示要应用到此图像的图像蒙版。
  • PDF数组表示要作为颜色键蒙版应用到图像的颜色范围。

更多详细信息请参阅<PDF Reference 1.7>中的第4.8.4节"图像字典"。

返回
表示蒙版的PDF对象。 如果 FSImageObject::isImageMask 返回YES,此函数将返回nil。

◆ getStream()

- (FSPDFStream *) getStream

获取图像流。

返回
表示图像流的 FSPDFStream 。 如果有任何错误,此函数将返回nil。

◆ isImageMask()

- (BOOL) isImageMask

检查当前图像对象是否被视为蒙版。

返回
YES 表示当前对象被视为蒙版,NO 表示不是。

◆ setBitmap:mask:()

- (void) setBitmap: (FSBitmap*)  bitmap
mask: (FSBitmap*)  mask 

将位图设置到当前图像图形对象。

参数
[in]bitmap要设置到当前图像的有效位图对象。
[in]mask蒙版位图。默认值:通过默认构造函数创建的位图对象,未设置任何值, 表示不使用蒙版。
如果此参数有效,其格式应为 FSBitmapDIB8bppMask 。
仅当参数bitmap没有alpha通道时,此参数才有用。
返回
无
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ setImage:frame_index:()

- (void) setImage: (FSImage*)  image
frame_index: (int)  frame_index 

将图像的一帧设置到当前图像图形对象。

输入图像可能包含多帧,只能将图像的一帧设置到当前图像图形对象。

参数
[in]image有效的图像对象。此图像应至少包含一帧,图像类型 不应为 FSImageUnknown 。
[in]frame_index帧索引,用于决定参数image的哪一帧要被设置。 有效范围:从0到(count-1)。count由函数 FSImage::getFrameCount 返回。
返回
无
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。