Foxit PDF SDK
FSGraphicsObject类 参考
类 FSGraphicsObject 继承关系图:
FSFormXObject FSImageObject FSPathObject FSShadingObject FSTextObject

构造函数

(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:
 变换当前图形对象。
更多...
 

属性

FSGraphicsObjectBlendMode blendMode
 获取透明成像模型的混合模式。

 
FSRectF * clipRect
 获取裁剪矩形。

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

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

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

 

详细描述

PDF页面的内容通常由一系列图形对象组成。每个图形对象包含其状态信息、数据和渲染指令。
类 FSGraphicsObject 是所有类型PDF图形对象的基类。 它提供获取/设置图形对象通用属性的基本函数。对于具体的图形对象类型,请参阅派生类。
要获取或插入/删除图形对象,请参阅类 FSGraphicsObjects 。
如果对PDF图形对象进行了任何更改,请记住为 FSGraphicsObjects 对象 (当前图形对象所属的对象)调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 的注释。

参见
FSGraphicsObjects

函数文档

◆ addClipPath:fill_mode:()

- (BOOL) addClipPath: (FSPath*)  path
fill_mode: (FSFillMode)  fill_mode 

添加用于裁剪的路径。

参数
[in]path要添加到当前图形对象的路径数据。
[in]fill_mode输入路径的填充模式。请参考从 FSFillModeNone 开始的值,这应该是这些值中的一个。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ addClipTextObject:()

- (BOOL) addClipTextObject: (FSTextObject*)  textobject

添加用于裁剪的文本对象。

参数
[in]textobject要添加用于裁剪的文本对象。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ clearClips()

- (BOOL) clearClips

清除所有裁剪。

返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ clone()

- (FSGraphicsObject *) clone

克隆新的图形对象。

新克隆的图形对象默认与当前图形对象关联到同一页面。 新克隆的图形对象只能在包含当前图形对象的PDF文件内使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中, 请记住在不再使用时调用函数 GraphicsObject::Release 来释放它。

返回
克隆的图形对象。如果有任何错误,此函数将返回nil。

◆ cloneWithSrcGraphicsobjects:dest_graphicsobjects:()

- (FSGraphicsObject *) cloneWithSrcGraphicsobjects: (FSGraphicsObjects*)  src_graphicsobjects
dest_graphicsobjects: (FSGraphicsObjects*)  dest_graphicsobjects 

克隆新的图形对象。

新克隆的图形对象与dest_graphicsobjects所属的页面相关联。 新克隆的图形对象可以在包含当前图形对象的PDF文件内外使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中, 请记住在不再使用时调用函数 GraphicsObject::Release 来释放它。

参数
[in]src_graphicsobjects包含当前图形对象的 FSGraphicsObjects 对象。
[in]dest_graphicsobjects将包含克隆图形对象的 FSGraphicsObjects 对象。 这可以属于当前文档中的另一页面或另一文档中的页面。
返回
克隆的图形对象。如果有任何错误,此函数将返回nil。

◆ getClipPath:()

- (FSPath *) getClipPath: (int)  index

根据索引获取路径裁剪。

参数
[in]index路径裁剪索引。有效范围:从0到(count-1)。 count 由函数 FSGraphicsObject::getClipPath: 返回。
返回
路径数据。如果返回路径对象的函数 FSPath::isEmpty 的返回值为YES, 表示有任何错误。

◆ getClipPathCount()

- (int) getClipPathCount

获取路径裁剪的数量。

返回
路径裁剪的数量。

◆ getClipPathFillMode:()

- (FSFillMode) getClipPathFillMode: (int)  index

根据索引获取路径裁剪的填充模式。

参数
[in]index路径裁剪索引。有效范围:从0到(count-1)。 count 由函数 FSGraphicsObject::getClipPath: 返回。
返回
填充模式。请参考从 FSFillModeNone 开始的值, 这将是这些值中的一个。

◆ getClipTextObject:()

- (FSTextObject *) getClipTextObject: (int)  index

根据索引获取文本裁剪的文本对象。

参数
[in]index文本裁剪索引。有效范围:从0到(count-1)。 count 由函数 FSGraphicsObject::getClipTextObjectCount 返回。
返回
文本图形对象。如果有任何错误,此函数将返回nil。

◆ getClipTextObjectCount()

- (int) getClipTextObjectCount

获取文本裁剪的数量。

返回
文本裁剪的数量。

◆ getFormXObject()

- (FSFormXObject *) getFormXObject

如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。

返回
表单XObject图形对象。如果当前图形对象不表示表单XObject对象, 此函数将返回nil。

◆ getImageObject()

- (FSImageObject *) getImageObject

如果当前图形对象表示图像对象,则获取图像图形对象。

返回
图像图形对象。如果当前图形对象不表示图像对象, 此函数将返回nil。

◆ getLayers:()

- (FSLayerNodeArray *) getLayers: (FSLayerTree*)  layer_tree

获取与当前图形对象关联的所有图层。

参数
[in]layer_tree有效的图层树。此图层树中的所有图层节点将按顺序枚举, 以查找与当前图形对象关联的图层。
返回
包含所有匹配图层节点的图层节点数组。

◆ getMarkedContent()

- (FSMarkedContent *) getMarkedContent

获取标记内容对象。

返回
标记内容对象。如果有任何错误,此函数将返回nil。

◆ getPathObject()

- (FSPathObject *) getPathObject

如果当前图形对象表示路径对象,则获取路径图形对象。

返回
路径图形对象。如果当前图形对象不表示路径对象, 此函数将返回nil。

◆ getRect()

- (FSRectF *) getRect

获取当前图形对象的矩形。

返回
当前图形对象的矩形。 如果有任何错误,此函数将返回一个所有值都为0的RectF对象。

◆ getShadingObject()

- (FSShadingObject *) getShadingObject

如果当前图形对象表示阴影对象,则获取阴影图形对象。

返回
阴影图形对象。如果当前图形对象不表示阴影对象, 此函数将返回nil。

◆ getTextObject()

- (FSTextObject *) getTextObject

如果当前图形对象表示文本对象,则获取文本图形对象。

返回
文本图形对象。如果当前图形对象不表示文本对象, 此函数将返回nil。

◆ getType()

- (FSGraphicsObjectType) getType

获取当前图形对象的类型。

返回
图形对象类型。请参考从 FSGraphicsObjectTypeText 开始的值, 这将是这些值中的一个,除了 FSGraphicsObjectTypeAll 。

◆ hasTransparency()

- (BOOL) hasTransparency

检查当前图形对象是否具有透明度。

返回
YES 表示当前图形对象具有透明度,NO 表示没有。

◆ removeClipPath:()

- (BOOL) removeClipPath: (int)  index

根据索引删除路径裁剪。

参数
[in]index路径裁剪索引。有效范围:从0到(count-1)。 count 由函数 FSGraphicsObject::getClipPath: 返回。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ removeClipTextObject:()

- (BOOL) removeClipTextObject: (int)  index

根据索引删除用于裁剪的文本裁剪。

参数
[in]index文本裁剪索引。有效范围:从0到(count-1)。 count 由函数 FSGraphicsObject::getClipTextObjectCount 返回。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ rotate:()

- (void) rotate: (int)  angle

从当前状态以指定的角度顺时针旋转当前图形对象。

参数
[in]angle角度值,用于从当前状态顺时针旋转当前图形对象。 值范围:从0到360。特别地,如果输入值为0或360(表示不旋转当前图形对象), 当前函数将不执行任何操作。
返回
无。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

◆ transform:need_transform_clippath:()

- (BOOL) transform: (FSMatrix2D*)  matrix
need_transform_clippath: (BOOL)  need_transform_clippath 

变换当前图形对象。

参数
[in]matrix变换矩阵。
[in]need_transform_clippathYES 表示与当前图形对象一起变换裁剪路径。 NO 表示仅变换当前图形对象。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用函数 FSGraphicsObjects::generateContent 。 更多详细信息请参阅函数 FSGraphicsObjects::generateContent 。

属性说明

◆ colorState

- (FSColorState *) colorState
readwritenonatomicweak

获取颜色状态。

文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。

◆ fillColor

- (unsigned int) fillColor
readwritenonatomicassign

获取填充颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 函数 FSGraphicsObject::colorState 可用于获取其他颜色空间(如CMYK颜色空间)中的填充颜色。

◆ graphState

- (FSGraphState *) graphState
readwritenonatomicweak

获取图形状态。

表单XObject图形对象、路径图形对象和文本图形对象可以具有此属性。

◆ strokeColor

- (unsigned int) strokeColor
readwritenonatomicassign

获取描边颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。
函数 FSGraphicsObject::colorState 可用于获取其他颜色空间(如CMYK颜色空间)中的描边颜色。