|
Foxit PDF SDK
|
Public 成员函数 | |
| 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 | 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 |
| 文本图形对象。 | |
Content of a PDF page usually consists of a sequence of graphics objects. Each graphics object contains its state information, data and instructions for rendering.
Class FSDK.GraphicsObject is the base class for all types of PDF graphics objects. It offers the base functions to get/set graphics object's common properties. For concrete graphics object types, please refer to derived classes.
To get or insert/remove a graphics object, please refer to class FSDK.GraphicsObjects.
If any change is done to a PDF graphics object, please remember to call function FSDK.GraphicsObjects.GenerateContent for FSDK.GraphicsObjects object (to which current graphics object belongs). Please refer to comment of function FSDK.GraphicsObjects.GenerateContent for more details.
| FSDK::GraphicsObject::AddClipPath | ( | path | , |
| fill_mode | |||
| ) |
添加路径用于剪裁。
| [in] | path | 要添加到当前图形对象的路径数据。 |
| [in] | fill_mode | 输入路径的填充模式。请参阅从 FSDK.e_FillModeNone 开始的值,这应该是这些值之一。 |
| FSDK::GraphicsObject::AddClipTextObject | ( | textobject | ) |
添加文本对象用于剪裁。
| [in] | textobject | 要添加用于剪裁的文本对象。 |
| FSDK::GraphicsObject::ClearClips | ( | ) |
Clear all clips.
| FSDK::GraphicsObject::Clone | ( | ) |
克隆一个新的图形对象。
新克隆的图形对象默认情况下与当前图形对象关联到同一页面。 新克隆的图形对象只能在包含当前图形对象的 PDF 文件内部使用。 如果克隆的图形对象没有插入到任何 PDF 页面或其他对象, 请记得在不再使用时调用函数 FSDK.GraphicsObject.Release 释放它。
| FSDK::GraphicsObject::Clone | ( | src_graphicsobjects | , |
| dest_graphicsobjects | |||
| ) |
克隆一个新的图形对象。
新克隆的图形对象与 dest_graphicsobjects 所属的页面关联。 新克隆的图形对象可以在包含当前图形对象的 PDF 文件内部或外部使用。 如果克隆的图形对象没有插入到任何 PDF 页面或其他对象, 请记得在不再使用时调用函数 FSDK.GraphicsObject.Release 释放它。
| FSDK::GraphicsObject::GetBlendMode | ( | ) |
获取透明成像模型的混合模式。
| FSDK::GraphicsObject::GetClipPath | ( | index | ) |
通过索引获取路径剪裁。
| [in] | index | 路径剪裁索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.GraphicsObject.GetClipPath 返回。 |
| FSDK::GraphicsObject::GetClipPathCount | ( | ) |
获取路径剪裁的数量。
| FSDK::GraphicsObject::GetClipPathFillMode | ( | index | ) |
通过索引获取路径剪裁的填充模式。
| [in] | index | 路径剪裁索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.GraphicsObject.GetClipPath 返回。 |
| FSDK::GraphicsObject::GetClipRect | ( | ) |
获取裁剪矩形。
| FSDK::GraphicsObject::GetClipTextObject | ( | index | ) |
通过索引获取文本剪裁的文本对象。
| [in] | index | 文本剪裁索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.GraphicsObject.GetClipTextObjectCount 返回。 |
| FSDK::GraphicsObject::GetClipTextObjectCount | ( | ) |
获取文本剪裁的数量。
| FSDK::GraphicsObject::GetColorState | ( | ) |
获取颜色状态。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有颜色状态。
| FSDK::GraphicsObject::GetFillColor | ( | ) |
获取填充颜色。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有此属性。 函数 FSDK.GraphicsObject.GetColorState 可用于获取其他颜色空间(如 CMYK 颜色空间)中的填充颜色。
| FSDK::GraphicsObject::GetFillOpacity | ( | ) |
获取除描边以外的绘画操作的不透明度值。
| FSDK::GraphicsObject::GetFormXObject | ( | ) |
如果当前图形对象表示表单 XObject 对象,则获取表单 XObject 图形对象。
| FSDK::GraphicsObject::GetGraphState | ( | ) |
获取图形状态。
表单 XObject 图形对象、路径图形对象和文本图形对象可以具有此属性。
| FSDK::GraphicsObject::GetImageObject | ( | ) |
如果当前图形对象表示图像对象,则获取图像图形对象。
| FSDK::GraphicsObject::GetLayers | ( | layer_tree | ) |
获取与当前图形对象关联的所有图层。
| [in] | layer_tree | 有效的图层树。将枚举此图层树中的所有图层节点 以找到与当前图形对象关联的图层。 |
| FSDK::GraphicsObject::GetMarkedContent | ( | ) |
获取标记内容对象。
| FSDK::GraphicsObject::GetMatrix | ( | ) |
获取矩阵。
| FSDK::GraphicsObject::GetPathObject | ( | ) |
如果当前图形对象表示路径对象,则获取路径图形对象。
| FSDK::GraphicsObject::GetRect | ( | ) |
获取当前图形对象的矩形。
| FSDK::GraphicsObject::GetShadingObject | ( | ) |
如果当前图形对象表示阴影对象,则获取阴影图形对象。
| FSDK::GraphicsObject::GetStrokeColor | ( | ) |
获取描边颜色。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有此属性。
函数 FSDK.GraphicsObject.GetColorState 可用于获取其他颜色空间(如 CMYK 颜色空间)中的描边颜色。
| FSDK::GraphicsObject::GetStrokeOpacity | ( | ) |
获取路径和字形轮廓的描边绘画操作的不透明度值。
| FSDK::GraphicsObject::GetTextObject | ( | ) |
如果当前图形对象表示文本对象,则获取文本图形对象。
| FSDK::GraphicsObject::GetType | ( | ) |
获取当前图形对象的类型。
| FSDK::GraphicsObject::HasTransparency | ( | ) |
检查当前 PDF 页面是否具有透明度。
Before using this function, please ensure current page has been parsed.
| FSDK::GraphicsObject::IsScanned | ( | ) |
检查当前 PDF 页面是否为扫描页。
Before using this function, please ensure current page has been parsed.
| FSDK::GraphicsObject::Release | ( | ) |
释放尚未插入到任何 PDF 页面或其他对象的克隆或新创建的 PDF 图形对象。
| FSDK::GraphicsObject::RemoveClipPath | ( | index | ) |
通过索引移除路径剪裁。
| [in] | index | 路径剪裁索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.GraphicsObject.GetClipPath 返回。 |
| FSDK::GraphicsObject::RemoveClipTextObject | ( | index | ) |
通过索引移除文本剪裁。
| [in] | index | 文本剪裁索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.GraphicsObject.GetClipTextObjectCount 返回。 |
| FSDK::GraphicsObject::Rotate | ( | angle | ) |
Rotate current graphics object from current state with specified angle degree in clockwise.
| [in] | angle | Angle degree value, which is used to rotate current graphics object from current state in clockwise. Value range: from 0 to 360. Specially, if the input value is 0 or 360 (which means not to rotate current graphics object), current function will do nothing. |
| FSDK::GraphicsObject::SetBlendMode | ( | blend_mode | ) |
设置透明成像模型的混合模式。
| [in] | blend_mode | 新的混合模式。请参阅从 FSDK.GraphicsObject.e_BlendNormal 开始的值, 这应该是这些值之一。 |
| FSDK::GraphicsObject::SetClipRect | ( | clip_rect | ) |
设置裁剪矩形。
默认情况下,新裁剪矩形将以 FSDK.e_FillModeWinding 填充模式设置。
| [in] | clip_rect | 新裁剪矩形。 |
| FSDK::GraphicsObject::SetColorState | ( | color_state | ) |
设置颜色状态。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有此属性。 如果尝试为其他不支持的类型设置颜色状态,将抛出异常 FSDK.e_ErrUnsupported。
| [in] | color_state | 要设置到当前图形对象的颜色状态对象。 |
| FSDK::GraphicsObject::SetFillColor | ( | color | ) |
设置填充颜色。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有颜色状态。 如果尝试为其他不支持的类型设置填充颜色,将抛出 FSDK.e_ErrUnsupported。
对于路径图形对象,请确保填充模式不是 FSDK.e_FillModeNone; 否则填充颜色将不会对路径图形对象产生任何影响。请参阅函数 FSDK.PathObject.GetFillMode 和 FSDK.PathObject.SetFillMode 以 检查和更改路径图形对象的填充模式。
函数 FSDK.GraphicsObject.SetColorState 可用于在其他颜色空间(如 CMYK 颜色空间)中设置填充颜色。
| [in] | color | 新的颜色值,格式为 0xAARRGGBB。 |
| FSDK::GraphicsObject::SetFillOpacity | ( | opacity | ) |
为除描边以外的绘画操作设置不透明度值。
| [in] | opacity | 新的不透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。 |
| FSDK::GraphicsObject::SetGraphState | ( | graph_state | ) |
设置图形状态。
表单 XObject 图形对象、路径图形对象和文本图形对象(其文本模式为 FSDK.TextState.e_ModeStroke、FSDK.TextState.e_ModeStrokeClip、 FSDK.TextState.e_ModeFillStroke 或 FSDK.TextState.e_ModeFillStrokeClip) 可以具有此属性。如果尝试为其他不支持的类型设置图形状态,将抛出异常 FSDK.e_ErrUnsupported。
| [in] | graph_state | 新的图形状态。 |
| FSDK::GraphicsObject::SetMatrix | ( | matrix | ) |
设置矩阵。
| [in] | matrix | 新的矩阵值。 |
| FSDK::GraphicsObject::SetStrokeColor | ( | color | ) |
设置描边颜色。
文本图形对象、路径图形对象和表单 XObject 图形对象可以具有此属性。 如果当前图形对象是文本图形对象并且文本模式为 FSDK.TextState.e_ModeFill, 则描边颜色将不会对文本图形对象产生影响。
如果尝试为其他不支持的类型设置描边颜色,将抛出异常 FSDK.e_ErrUnsupported。
函数 FSDK.GraphicsObject.SetColorState 可用于在其他颜色空间(如 CMYK 颜色空间)中设置描边颜色。
| [in] | color | 新的颜色值,格式为 0xAARRGGBB。 |
| FSDK::GraphicsObject::SetStrokeOpacity | ( | opacity | ) |
为路径和字形轮廓的描边绘画操作设置不透明度值。
| [in] | opacity | 新的不透明度值。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。 |
| FSDK::GraphicsObject::Transform | ( | matrix | , |
| need_transform_clippath | |||
| ) |
变换当前图形对象。
| [in] | matrix | 变换矩阵。 |
| [in] | need_transform_clippath | true 表示与当前图形对象一起变换剪裁路径。 false 表示仅变换当前图形对象。 |
|
static |
创建具有源颜色的色调和饱和度以及背景颜色的亮度的颜色。
公式如下:
B(Cb, Cs) = SetLum(Cs, Lum(Cb))。
|
static |
Darkens backdrop color to reflect the source color.
Painting with white produces no changes.
Here is the formula :
B(Cb, Cs) =
-1 - min(1, (1 - Cb) / Cs) if Cs > 0
-0 if Cs = 0
|
static |
Brightens backdrop color to reflect source colors.
Painting with black produces no changes.
Here is the formula :
B(Cb, Cs) =
-min(1, Cb / (1 - Cs)) if Cs < 1
-1 if Cs = 1
|
static |
Select darker one of backdrop and source colors.
Here is the formula :
B(Cb, Cs) = min(Cb, Cs).
|
static |
Subtracts the darker of the two constituent colors from lighter colors.
Here is the formula :
B(Cb, Cs) = |Cb - Cs|.
|
static |
创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。
公式如下:
B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb))。
|
static |
Multiply or screens colors, depending on source color value.
Here is the formula :
B(Cb, Cs) =
-Multiply(Cb, 2 * Cs) if Cs <= 0.5
-Screen(Cb, 2 * Cs - 1) if Cs > 0.5
|
static |
创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。
公式如下:
B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb))。
|
static |
Select lighter one of backdrop and source colors.
Here is the formula :
B(Cb, Cs) = max(Cb, Cs).
|
static |
创建具有源颜色的亮度以及背景颜色的色调和饱和度的颜色。
公式如下:
B(Cb, Cs) = SetLum(Cb, Lum(Cs))。
|
static |
Multiply backdrop by source color values.
Here is the formula :
B(Cb, Cs) = Cb * Cs.
|
static |
Enumeration for render blend mode.
Values of this enumeration should be used alone.Selecting source color and ignoring backdrop color.
Here is the formula :
B(Cb, Cs) = Cs.
|
static |
Multiply or screens colors, depending on backdrop color value.
Here is the formula :
B(Cb, Cs) = HardLight(Cs, Cb).
|
static |
创建具有源颜色的饱和度、 以及背景颜色的色调和亮度的颜色。
公式如下:
B(Cb, Cs) = SetLum(SetSat(Cb, Sat(Cs)), Lum(Cb))。
|
static |
Multiply complements of backdrop by source color values, and then complement the result.
Here is the formula :
B(Cb, Cs) = 1 - [(1 - Cb) * (1 - Cs)] = Cb + Cs - Cb * Cs.
|
static |
Darkens or lightens colors, depending on source color value.
Here is the formula :
B(Cb, Cs) =
-Cb - (1 - 2 * Cs) * Cb * (1 - Cb) if Cs <= 0.5
-Cb + (2 * Cs - 1) * (D(Cb) - Cb) if Cs > 0.5
where D(x) =
-((16 * x - 12) * x + 4) * x if x <= 0.25
-sqrt(x) if x > 0.25
|
static |
PDF 图形对象类型的枚举。
此枚举的值应单独使用。表示所有图形对象类型,仅用作过滤器。