Foxit PDF SDK
|
Public Types | |
enum | BlendMode { BlendMode.e_BlendNormal = 0, BlendMode.e_BlendMultiply = 1, BlendMode.e_BlendScreen = 2, BlendMode.e_BlendOverlay = 3, BlendMode.e_BlendDarken = 4, BlendMode.e_BlendLighten = 5, BlendMode.e_BlendColorDodge = 6, BlendMode.e_BlendColorBurn = 7, BlendMode.e_BlendHardlight = 8, BlendMode.e_BlendSoftlight = 9, BlendMode.e_BlendDifference = 10, BlendMode.e_BlendExclusion = 11, BlendMode.e_BlendHue = 21, BlendMode.e_BlendSaturation = 22, BlendMode.e_BlendColor = 23, BlendMode.e_BlendLuminosity = 24 } |
Enumeration for render blend mode. More... | |
enum | Type { Type.e_TypeAll = 0, Type.e_TypeText = 1, Type.e_TypePath = 2, Type.e_TypeImage = 3, Type.e_TypeShading = 4, Type.e_TypeFormXObject = 5 } |
Enumeration for PDF graphics object type. More... | |
Public Member Functions | |
bool | AddClipPath (Path path, FillMode fill_mode) |
Add a path for clipping. More... | |
bool | AddClipTextObject (TextObject textobject) |
Add text object for clipping. More... | |
bool | ClearClips () |
Clear all clips. More... | |
GraphicsObject | Clone () |
Clone a new graphics object. More... | |
bool | Equal (GraphicsObject other) |
Check if input object is equal to current object. More... | |
GraphicsObject.BlendMode | GetBlendMode () |
Get the blend mode for transparent imaging model. More... | |
Path | GetClipPath (int index) |
Get a path clip by index. More... | |
int | GetClipPathCount () |
Get the count of path clip. More... | |
FillMode | GetClipPathFillMode (int index) |
Get the fill mode of a path clip by index. More... | |
RectF | GetClipRect () |
Get clip rectangle. More... | |
TextObject | GetClipTextObject (int index) |
Get the text object of a text clip by index. More... | |
int | GetClipTextObjectCount () |
Get the count of text clip. More... | |
ColorState | GetColorState () |
Get color state. More... | |
uint | GetFillColor () |
Get the fill color. More... | |
float | GetFillOpacity () |
Get the opacity value for painting operations other than stroking. More... | |
FormXObject | GetFormXObject () |
Get the form XObject graphics object if current graphics object represents a form XObject object. More... | |
GraphState | GetGraphState () |
Get graph state. More... | |
ImageObject | GetImageObject () |
Get the image graphics object if current graphics object represents an image object. More... | |
LayerNodeArray | GetLayers (LayerTree layer_tree) |
Get all the layers which are associated with current graphics object. More... | |
MarkedContent | GetMarkedContent () |
Get marked content object. More... | |
Matrix2D | GetMatrix () |
Get matrix. More... | |
PathObject | GetPathObject () |
Get the path graphics object if current graphics object represents a path object. More... | |
RectF | GetRect () |
Get the rectangle of current graphics object. More... | |
ShadingObject | GetShadingObject () |
Get the shading graphics object if current graphics object represents a shading object. More... | |
uint | GetStrokeColor () |
Get the stroke color. More... | |
float | GetStrokeOpacity () |
Get opacity value for stroke painting operations for paths and glyph outlines. More... | |
TextObject | GetTextObject () |
Get the text graphics object if current graphics object represents a text object. More... | |
GraphicsObject.Type | GetType () |
Get the type of current graphics object. More... | |
bool | HasTransparency () |
Check whether current graphics object has transparency or not. More... | |
void | Release () |
Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object. More... | |
bool | RemoveClipPath (int index) |
Remove a path clip by index. More... | |
bool | RemoveClipTextObject (int index) |
Remove a text clip by index for clipping. More... | |
void | Rotate (int angle) |
Rotate current graphics object from current state with specified angle degree in clockwise. More... | |
void | SetBlendMode (GraphicsObject.BlendMode blend_mode) |
Set the blend mode for transparent imaging model. More... | |
void | SetClipRect (RectF clip_rect) |
Set clip rectangle. More... | |
void | SetColorState (ColorState color_state) |
Set color state. More... | |
void | SetFillColor (uint color) |
Set the fill color. More... | |
void | SetFillOpacity (float opacity) |
Set the opacity value for painting operations other than stroking. More... | |
void | SetGraphState (GraphState graph_state) |
Set graph state. More... | |
void | SetMatrix (Matrix2D matrix) |
Set matrix. More... | |
void | SetStrokeColor (uint color) |
Set the stroke color. More... | |
void | SetStrokeOpacity (float opacity) |
Set opacity value for stroke painting operations for paths and glyph outlines. More... | |
bool | Transform (Matrix2D matrix, bool need_transform_clippath) |
Transform current graphics object. More... | |
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 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 foxit.pdf.GraphicsObjects .
If any change is done to a PDF graphics object, please remember to call function GraphicsObjects.GenerateContent for foxit.pdf.GraphicsObjects object (to which current graphics object belongs). Please refer to comment of function GraphicsObjects.GenerateContent for more details.
|
strong |
Enumeration for render blend mode.
Values of this enumeration should be used alone.
|
strong |
Enumeration for PDF graphics object type.
Values of this enumeration should be used alone.
Add a path for clipping.
[in] | path | Path data to be added to current graphics object. |
[in] | fill_mode | Fill mode for the input path. Please refer to values starting from foxit.common.FillMode.e_FillModeNone and this should be one of these values. |
|
inline |
Add text object for clipping.
[in] | textobject | Text object to be added for clipping. |
|
inline |
Clear all clips.
|
inline |
Clone a new graphics object.
Newly cloned graphics object is related to the same page with current graphics object by default. Newly cloned graphics object can only be used inside the PDF file which contains current graphics object. If the cloned graphics object is not inserted to any PDF page or other object, please remember to call function GraphicsObject.Release to release it when not use it any more.
|
inline |
Check if input object is equal to current object.
[in] | other | Another graphics object. This function will check if current object is equal to this one. |
|
inline |
Get the blend mode for transparent imaging model.
|
inline |
Get a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.GetClipPath . |
|
inline |
Get the count of path clip.
|
inline |
Get the fill mode of a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.GetClipPath . |
|
inline |
Get clip rectangle.
|
inline |
Get the text object of a text clip by index.
[in] | index | Text clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.GetClipTextObjectCount . |
|
inline |
Get the count of text clip.
|
inline |
Get color state.
Text graphics object, path graphics object, and form XObject graphics object can have color state.
|
inline |
Get the fill color.
Text graphics object, path graphics object, and form XObject graphics object can have this property. Function GraphicsObject.GetColorState can be used to get fille color in other color space, like CMYK color space.
|
inline |
Get the opacity value for painting operations other than stroking.
|
inline |
Get the form XObject graphics object if current graphics object represents a form XObject object.
|
inline |
Get graph state.
Form XObjet graphics object, path graphics object and text graphics object can have this property.
|
inline |
Get the image graphics object if current graphics object represents an image object.
|
inline |
Get all the layers which are associated with current graphics object.
[in] | layer_tree | A valid layer tree. All the layer nodes in this layer tree will be enumerated in order to find which are associated with current graphics object. |
|
inline |
Get marked content object.
|
inline |
Get matrix.
|
inline |
Get the path graphics object if current graphics object represents a path object.
|
inline |
Get the rectangle of current graphics object.
|
inline |
Get the shading graphics object if current graphics object represents a shading object.
|
inline |
Get the stroke color.
Text graphics object, path graphics object, and form XObject graphics object can have this property.
Function GraphicsObject.GetColorState can be used to get stroke color in other color space, like CMYK color space.
|
inline |
Get opacity value for stroke painting operations for paths and glyph outlines.
|
inline |
Get the text graphics object if current graphics object represents a text object.
|
inline |
Get the type of current graphics object.
|
inline |
Check whether current graphics object has transparency or not.
|
inline |
Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object.
|
inline |
Remove a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.GetClipPath . |
|
inline |
Remove a text clip by index for clipping.
[in] | index | Text clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.GetClipTextObjectCount . |
|
inline |
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. |
|
inline |
Set the blend mode for transparent imaging model.
[in] | blend_mode | New blend mode. Please refer to values starting from foxit.pdf.graphics.GraphicsObject.BlendMode.e_BlendNormal and this should be one of these values. |
|
inline |
Set clip rectangle.
New clip rectangle will be set with fill mode foxit.common.FillMode.e_FillModeWinding by default.
[in] | clip_rect | New clip rectangle. |
|
inline |
Set color state.
Text graphics object, path graphics object, and form XObject graphics object can have this property. If try to set color state for rest unsupported types, exception foxit.common.ErrorCode.e_ErrUnsupported will be thrown.
[in] | color_state | A color state object to be set to current graphics object. |
|
inline |
Set the fill color.
Text graphics object, path graphics object, and form XObject graphics object can have color state. If try to set fill color for rest unsupported types, foxit.common.ErrorCode.e_ErrUnsupported will be thrown.
For path graphics object, please ensure the fill mode is not foxit.common.FillMode.e_FillModeNone ; otherwise the fill color will not have any effect on the path graphics object. Please refer to functions PathObject.GetFillMode and PathObject.SetFillMode to check and change the fill mode of a path graphics object.
Function GraphicsObject.SetColorState can be used to set fill color in other color space, like CMYK color space.
[in] | color | New color value, in format 0xAARRGGBB. |
|
inline |
Set the opacity value for painting operations other than stroking.
[in] | opacity | The new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |
|
inline |
Set graph state.
Form XObjet graphics object, path graphics object and text graphics object (whose text mode is foxit.pdf.graphics.TextState.Mode.e_ModeStroke , foxit.pdf.graphics.TextState.Mode.e_ModeStrokeClip , foxit.pdf.graphics.TextState.Mode.e_ModeFillStroke or foxit.pdf.graphics.TextState.Mode.e_ModeFillStrokeClip ) can have this property. If try to set graph state to rest unsupported types, exception foxit.common.ErrorCode.e_ErrUnsupported will be thrown.
[in] | graph_state | New graph state. |
|
inline |
Set matrix.
[in] | matrix | New matrix value. |
|
inline |
Set the stroke color.
Text graphics object, path graphics object, and form XObject graphics object can have this property. If current graphics object is a text graphics object and the text mode is foxit.pdf.graphics.TextState.Mode.e_ModeFill , the stroke color will not have effect on the text graphics object.
If try to set stroke color for rest unsupported types, exception foxit.common.ErrorCode.e_ErrUnsupported will be thrown.
Function GraphicsObject.SetColorState can be used to set stroke color in other color space, like CMYK color space.
[in] | color | New color value, in format 0xAARRGGBB. |
|
inline |
Set opacity value for stroke painting operations for paths and glyph outlines.
[in] | opacity | The new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |
|
inline |
Transform current graphics object.
[in] | matrix | Transform matrix. |
[in] | need_transform_clippath | true means to transform clip path with current graphics object. false means to transform current graphics object only. |