Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
FSDK::ImageObject类 参考
类 FSDK::ImageObject 继承关系图:

## Public 成员函数
| CloneBitmap (graphics_objects)
| 从当前图像图形对象克隆位图。 更多...
| CloneBitmap (page, graphics_objects)
| Clone the bitmap from current image graphics object. 更多...
| GetColorSpace ()
| 获取颜色空间。 更多...
| GetMask ()
| 获取表示当前图像图形对象掩码的 PDF 对象。 更多...
| GetStream ()
| 获取图像流。 更多...
| IsImageMask ()
| 检查当前图像对象是否被视为掩码。 更多...
| SetBitmap (bitmap, mask)
| 将位图设置到当前图像图形对象。 更多...
| SetImage (image, frame_index)
| 将图像的一帧设置到当前图像图形对象。 更多...
Public 成员函数 继承自 FSDK::GraphicsObject
| AddClipPath (path, fill_mode)
| 添加路径用于剪裁。 更多...
| AddClipTextObject (textobject)
| 添加文本对象用于剪裁。 更多...
| ClearClips ()
| Clear all clips. 更多...
| Clone ()
| 克隆一个新的图形对象。 更多...
| Clone (src_graphicsobjects, dest_graphicsobjects)
| 克隆一个新的图形对象。 更多...
| GetBlendMode ()
| 获取透明成像模型的混合模式。 更多...
| GetClipPath (index)
| 通过索引获取路径剪裁。 更多...
| GetClipPathCount ()
| 获取路径剪裁的数量。 更多...
| GetClipPathFillMode (index)
| 通过索引获取路径剪裁的填充模式。 更多...
| GetClipRect ()
| 获取裁剪矩形。 更多...
| GetClipTextObject (index)
| 通过索引获取文本剪裁的文本对象。 更多...
| GetClipTextObjectCount ()
| 获取文本剪裁的数量。 更多...
| GetColorState ()
| 获取颜色状态。 更多...
| GetFillColor ()
| 获取填充颜色。 更多...
| GetFillOpacity ()
| 获取除描边以外的绘画操作的不透明度值。 更多...
| GetFormXObject ()
| 如果当前图形对象表示表单 XObject 对象，则获取表单 XObject 图形对象。 更多...
| GetGraphState ()
| 获取图形状态。 更多...
| GetImageObject ()
| 如果当前图形对象表示图像对象，则获取图像图形对象。 更多...
| GetLayers (layer_tree)
| 获取与当前图形对象关联的所有图层。 更多...
| GetMarkedContent ()
| 获取标记内容对象。 更多...
| GetMatrix ()
| 获取矩阵。 更多...
| GetPathObject ()
| 如果当前图形对象表示路径对象，则获取路径图形对象。 更多...
| GetRect ()
| 获取当前图形对象的矩形。 更多...
| GetShadingObject ()
| 如果当前图形对象表示阴影对象，则获取阴影图形对象。 更多...
| GetStrokeColor ()
| 获取描边颜色。 更多...
| GetStrokeOpacity ()
| 获取路径和字形轮廓的描边绘画操作的不透明度值。 更多...
| GetTextObject ()
| 如果当前图形对象表示文本对象，则获取文本图形对象。 更多...
| GetType ()
| 获取当前图形对象的类型。 更多...
| HasTransparency ()
| 检查当前 PDF 页面是否具有透明度。 更多...
| IsScanned ()
| 检查当前 PDF 页面是否为扫描页。 更多...
| Release ()
| 释放尚未插入到任何 PDF 页面或其他对象的克隆或新创建的 PDF 图形对象。 更多...
| RemoveClipPath (index)
| 通过索引移除路径剪裁。 更多...
| RemoveClipTextObject (index)
| 通过索引移除文本剪裁。 更多...
| Rotate (angle)
| Rotate current graphics object from current state with specified angle degree in clockwise. 更多...
| SetBlendMode (blend_mode)
| 设置透明成像模型的混合模式。 更多...
| SetClipRect (clip_rect)
| 设置裁剪矩形。 更多...
| SetColorState (color_state)
| 设置颜色状态。 更多...
| SetFillColor (color)
| 设置填充颜色。 更多...
| SetFillOpacity (opacity)
| 为除描边以外的绘画操作设置不透明度值。 更多...
| SetGraphState (graph_state)
| 设置图形状态。 更多...
| SetMatrix (matrix)
| 设置矩阵。 更多...
| SetStrokeColor (color)
| 设置描边颜色。 更多...
| SetStrokeOpacity (opacity)
| 为路径和字形轮廓的描边绘画操作设置不透明度值。 更多...
| Transform (matrix, need_transform_clippath)
| 变换当前图形对象。 更多...

## 静态 Public 成员函数
static | Create (document)
| 创建新的图像图形对象。 更多...
static | CreateFromType3TextObject (page, text_obj)
| 从 type3 文本对象创建图像图形对象。 更多...

## 额外继承的成员函数
静态 Public 属性 继承自 FSDK::GraphicsObject
static | e_BlendColor
| 创建具有源颜色的色调和饱和度以及背景颜色的亮度的颜色。 更多...
static | e_BlendColorBurn
| Darkens backdrop color to reflect the source color. 更多...
static | e_BlendColorDodge
| Brightens backdrop color to reflect source colors. 更多...
static | e_BlendDarken
| Select darker one of backdrop and source colors. 更多...
static | e_BlendDifference
| Subtracts the darker of the two constituent colors from lighter colors. 更多...
static | e_BlendExclusion
| 创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。 更多...
static | e_BlendHardlight
| Multiply or screens colors, depending on source color value. 更多...
static | e_BlendHue
| 创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。 更多...
static | e_BlendLighten
| Select lighter one of backdrop and source colors. 更多...
static | e_BlendLuminosity
| 创建具有源颜色的亮度以及背景颜色的色调和饱和度的颜色。 更多...
static | e_BlendMultiply
| Multiply backdrop by source color values. 更多...
static | e_BlendNormal
| Enumeration for render blend mode. 更多...
static | e_BlendOverlay
| Multiply or screens colors, depending on backdrop color value. 更多...
static | e_BlendSaturation
| 创建具有源颜色的饱和度、 以及背景颜色的色调和亮度的颜色。 更多...
static | e_BlendScreen
| Multiply complements of backdrop by source color values, and then complement the result. 更多...
static | e_BlendSoftlight
| Darkens or lightens colors, depending on source color value. 更多...
static | e_TypeAll
| PDF 图形对象类型的枚举。 更多...
static | e_TypeFormXObject
| 表单 XObject 图形对象。
static | e_TypeImage
| 图像图形对象。
static | e_TypePath
| 路径图形对象。
static | e_TypeShading
| 渐变图形对象。
static | e_TypeText
| 文本图形对象。

## 详细描述

Image graphics object is a kind of PDF graphics object, so class FSDK.ImageObject is derived from class FSDK.GraphicsObject. It offers functions to get/set image graphics object's data.
To create a new image graphics object, please use function FSDK.ImageObject.Create and then use setting functions to set information to the new image graphics object.

参见
  FSDK.GraphicsObject

## 成员函数说明

## ◆ CloneBitmap() [1/2]

FSDK::ImageObject::CloneBitmap | ( | graphics_objects |  | ) |

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

弃用:
  此函数已弃用。请改用带有两个参数的函数 FSDK.ImageObject.CloneBitmap。

目前，只有当位图格式为以下格式之一时，才能从图像图形对象克隆位图：
FSDK.Bitmap.e_DIB8bppMask、FSDK.Bitmap.e_DIB8bpp、 FSDK.Bitmap.e_DIBRgb、FSDK.Bitmap.e_DIBRgb32、 FSDK.Bitmap.e_DIBArgb、FSDK.Bitmap.e_DIBCmyk。
如果返回的位图对象的函数 FSDK.Bitmap.IsEmpty 的返回值为 true， 则表示位图的DIB格式不受支持。

参数

  [in] | graphics_objects | 有效的 FSDK.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此 FSDK.GraphicsObjects 对象（它可能是PDF页面）。

返回
  新的克隆位图对象。如果返回的位图对象的函数 FSDK.Bitmap.IsEmpty 的返回值为 true， 则表示位图的DIB格式不受支持。

## ◆ CloneBitmap() [2/2]

FSDK::ImageObject::CloneBitmap | ( | page | ,
|  | graphics_objects |
| ) |  |

Clone the bitmap from current image graphics object.

Currently, the bitmap can be cloned from image graphics object only when the bitmap format is one of following formats:
FSDK.Bitmap.e_DIB8bppMask, FSDK.Bitmap.e_DIB8bpp, FSDK.Bitmap.e_DIBRgb, FSDK.Bitmap.e_DIBRgb32, FSDK.Bitmap.e_DIBArgb, FSDK.Bitmap.e_DIBCmyk.
If the return value of function FSDK.Bitmap.IsEmpty for the returned bitmap object is true, that means the DIB format of the bitmap is unsupported.

参数

  [in] | page | A valid PDF page object. Please ensure that current image graphics object just belongs to this page.
  [in] | graphics_objects | A valid FSDK.GraphicsObjects object. Please ensure that current image graphics object just belongs to this FSDK.GraphicsObjects object (it may be a PDF page).

返回
  The new cloned bitmap object. If the return value of function FSDK.Bitmap.IsEmpty for the returned bitmap object is true, that means the DIB format of the bitmap is unsupported.

## ◆ Create()

static FSDK::ImageObject::Create | ( | document |  | ) |
| static

创建新的图像图形对象。

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

参数

  [in] | document | 有效的 PDF 文档对象。新图像图形对象应该插入到 此 PDF 文档的某个页面中。

返回
  新的图像对象。如果出现任何错误，此函数将返回 null。

## ◆ CreateFromType3TextObject()

static FSDK::ImageObject::CreateFromType3TextObject | ( | page | ,
|  | text_obj |
| ) |  |
| static

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

如果新创建的图像图形对象不会插入到任何页面或其他对象， 请在不再使用时记得调用函数 FSDK.GraphicsObject.Release 释放它。

参数

  [in] | page | 有效的 PDF 页面对象。
  [in] | text_obj | 有效的文本对象。此文本对象应该是 type3 文本对象。

返回
  新的图像对象。如果出现任何错误，此函数将返回 NULL。

## ◆ GetColorSpace()

FSDK::ImageObject::GetColorSpace | ( |  | ) |

获取颜色空间。

返回
  颜色空间。请参考从 FSDK.e_ColorSpaceDeviceGray 开始的值， 并且将是这些值之一。

## ◆ GetMask()

FSDK::ImageObject::GetMask | ( |  | ) |

获取表示当前图像图形对象掩码的 PDF 对象。

掩码可以是 PDF 字典或 PDF 数组：

- PDF 字典表示要应用于此图像的图像掩码。
- PDF 数组表示要作为颜色键掩码应用的颜色范围。

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

返回
  表示掩码的 PDF 对象。 如果 FSDK.ImageObject.IsImageMask 返回 true，此函数将返回 null。

## ◆ GetStream()

FSDK::ImageObject::GetStream | ( |  | ) |

获取图像流。

返回
  表示图像流的 FSDK.PDFStream。 如果出现任何错误，此函数将返回 null。

## ◆ IsImageMask()

FSDK::ImageObject::IsImageMask | ( |  | ) |

检查当前图像对象是否被视为掩码。

返回
  true 表示当前对象被视为掩码，而 false 表示不是。

## ◆ SetBitmap()

FSDK::ImageObject::SetBitmap | ( | bitmap | ,
|  | mask |
| ) |  |

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

参数

  [in] | bitmap | 要设置到当前图像的有效位图对象。
  [in] | mask | 掩码位图。默认值：由默认构造函数创建的位图对象且未设置任何值， 表示不使用掩码。 如果此参数有效，其格式应为 FSDK.Bitmap.e_DIB8bppMask。 仅当参数 bitmap 没有 alpha 通道时，此参数才有用。

返回
  无。

注解
  When this function succeeds, function FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.

## ◆ SetImage()

FSDK::ImageObject::SetImage | ( | image | ,
|  | frame_index |
| ) |  |

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

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

参数

  [in] | image | 有效的图像对象。此图像应至少包含一帧，且图像类型 不应为 FSDK.Image.e_Unknown。
  [in] | frame_index | 用于决定要设置参数 image 的哪一帧的帧索引。 有效范围：从 0 到 (count-1)。count 由函数 FSDK.Image.GetFrameCount 返回。

返回
  无

注解
  当此函数成功时，应调用函数 FSDK.GraphicsObjects.GenerateContent。 有关更多详细信息，请参考函数 FSDK.GraphicsObjects.GenerateContent。