Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::ofd::graphics::OFDPathObject类 参考
类 foxit::ofd::graphics::OFDPathObject 继承关系图:

## Public 类型
enum | PathFillMode { e_PathFillNonZero = 0, e_PathFillEvenOdd = 1 }
| OFD路径填充模式枚举。 更多...
Public 类型 继承自 foxit::ofd::graphics::OFDGraphicsObject
enum | LineCapMode { e_LineCapButt = 0, e_LineCapRound = 1, e_LineCapSquare = 2 }
| OFD线端点样式枚举。 更多...
enum | LineJoinMode { e_LineJoinMiter = 0, e_LineJoinRound = 1, e_LineJoinBevel = 2 }
| OFD线条连接样式枚举。 更多...
enum | ObjectType { e_ObjectTypeUnknown = 0, e_ObjectTypePageBlock = 2, e_ObjectTypeComposite = 3, e_ObjectTypeSVG = 4, e_ObjectTypeText = 5, e_ObjectTypePath = 6, e_ObjectTypeImage = 7, e_ObjectTypeVideo = 8 }
| OFD图元对象类型定义枚举类型. 更多...

## Public 成员函数
| OFDPathObject (OFDGraphicsObject object)
| 构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。 更多...
| OFDPathObject (const OFDPathObject &other)
| 构造函数，通过另一个OFD路径对象。 更多...
| ~OFDPathObject ()
| 析构函数。
String | GetAbbreviatedData ()
| 获取路径对象中路径元素描述序列。 更多...
PathFillMode | GetFillMode ()
| 获取路径对象填充模式。 更多...
OFDPathData | GetPathData ()
| 获取路径数据对象。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsFill ()
| 判断路径对象填充属性。 更多...
bool | IsStroke ()
| 判断路径对象描边属性。 更多...
bool | operator != (const OFDPathObject &other) const
| 不相等操作符。 更多...
OFDPathObject & | operator= (const OFDPathObject &other)
| 赋值操作符。 更多...
bool | operator== (const OFDPathObject &other) const
| 相等操作符。 更多...
void | SetAbbreviatedData (const String &abbreviated_data)
| 设置路径对象中路径元素描述序列。 更多...
void | SetFill (bool fill)
| 设置路径对象填充属性。 更多...
void | SetFillMode (PathFillMode fill_mode=e_PathFillNonZero)
| 设置路径对象填充模式。 更多...
void | SetPathData (const OFDPathData &path)
| 设置路径数据对象。 更多...
void | SetStroke (bool stroke)
| 设置路径对象描边属性。 更多...
Public 成员函数 继承自 foxit::ofd::graphics::OFDGraphicsObject
| OFDGraphicsObject (const OFDGraphicsObject &other)
| 构造函数，通过另一个OFD图元对象。 更多...
| ~OFDGraphicsObject ()
| 析构函数。
Actions | CreateActions ()
| 创建图元对象动作集合对象。 更多...
Actions | GetActions ()
| 获取图元对象的动作集合。 更多...
foxit::uint8 | GetAlpha ()
| 获取图元对象alpha属性。 更多...
BorderInfo | GetBorderInfo ()
| 获取图元对象边框信息(只有Image和Video对象可能会存在边框)。 更多...
foxit::RectF | GetBoundary ()
| 获取图元对象矩形外接框。 更多...
float | GetDashOffset ()
| 获取图元对象虚线重复样式。 更多...
foxit::FloatArray | GetDashPattern ()
| 获取图元对象虚线重复样式数组。 更多...
foxit::RGB | GetFillColor ()
| 获取图元对象填充颜色。 更多...
foxit::uint32 | GetID ()
| 获取图元对象资源ID。 更多...
LineCapMode | GetLineCap ()
| 获取图元对象线帽样式。 更多...
LineJoinMode | GetLineJoin ()
| 获取线条连接样式。 更多...
float | GetLineWidth ()
| 获取图元对象线宽。 更多...
foxit::Matrix | GetMatrix ()
| 获取图元对象矩阵。 更多...
float | GetMiterLimit ()
| 获取图元对象斜切限制值。 更多...
String | GetName ()
| 获取图元对象名称。 更多...
int | GetPageIndex ()
| 获取图元对象所在页面的索引号。 更多...
foxit::RGB | GetStrokeColor ()
| 获取图元对象勾边颜色。 更多...
ObjectType | GetType ()
| 获取图元对象类型。 更多...
bool | HasBorder ()
| 判断图元对象是否有边框。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | IsVisible ()
| 获取图元对象可见性属性。 更多...
bool | operator != (const OFDGraphicsObject &other) const
| 不相等操作符。 更多...
OFDGraphicsObject & | operator= (const OFDGraphicsObject &other)
| 赋值操作符。 更多...
bool | operator== (const OFDGraphicsObject &other) const
| 相等操作符。 更多...
void | SetAlpha (foxit::uint8 alpha)
| 设置图元对象alpha属性。 更多...
void | SetBorderInfo (const BorderInfo &border_info)
| 设置图元对象边框信息。 更多...
void | SetBoundary (const RectF &boundary)
| 设置图元对象矩形外接框。 更多...
void | SetDashOffset (float dash_offset)
| 设置图元对象虚线重复样式起始值。 更多...
void | SetDashPattern (float dash_offset, const foxit::FloatArray &dash_offset_array)
| 设置图元对象虚线重复样式。 更多...
void | SetFillColor (foxit::uint32 fill_color)
| 设置图元对象填充颜色。 更多...
void | SetLineCap (LineCapMode line_cap=e_LineCapButt)
| 设置图元对象线帽样式。 更多...
void | SetLineJoin (LineJoinMode line_join=e_LineJoinMiter)
| 设置线条连接样式。 更多...
void | SetLineWidth (float line_width)
| 设置图元对象线宽。 更多...
void | SetMatrix (const Matrix &mt)
| 设置图元对象矩阵。 更多...
void | SetMiterLimit (float miter_limit)
| 设置图元对象斜切限制值。 更多...
void | SetName (const String &name)
| 设置图元对象名称。 更多...
void | SetStrokeColor (foxit::uint32 stroke_color)
| 设置图元对象勾边颜色。 更多...
void | SetVisible (bool visible)
| 设置图元对象可见性属性。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD路径对象相关的方法。

## 成员枚举类型说明

## ◆ PathFillMode

enum foxit::ofd::graphics::OFDPathObject::PathFillMode

OFD路径填充模式枚举。

该枚举值应单独使用。

枚举值
e_PathFillNonZero | 非零填充。
e_PathFillEvenOdd | 奇偶填充。

## 构造及析构函数说明

## ◆ OFDPathObject() [1/2]

foxit::ofd::graphics::OFDPathObject::OFDPathObject | ( | OFDGraphicsObject | object | ) |
| explicit

构造函数，从现有foxit::ofd::graphics::OFDGraphicsObject对象。

参数

  [in] | object | OFDGraphicsObject对象。 此对象必须是一个有效的对象，并且其类型必须是foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypePath，否则构造函数将抛出异常。

## ◆ OFDPathObject() [2/2]

foxit::ofd::graphics::OFDPathObject::OFDPathObject | ( | const OFDPathObject & | other | ) |

构造函数，通过另一个OFD路径对象。

参数

  [in] | other | 另一个OFD路径对象。

## 成员函数说明

## ◆ GetAbbreviatedData()

String foxit::ofd::graphics::OFDPathObject::GetAbbreviatedData | ( |  | ) |

获取路径对象中路径元素描述序列。

返回
  路径元素描述字符串。

## ◆ GetFillMode()

PathFillMode foxit::ofd::graphics::OFDPathObject::GetFillMode | ( |  | ) |

获取路径对象填充模式。

返回
  路径对象填充模式值。请参考从 foxit::ofd::graphics::OFDPathObject::e_PathFillNonZero 开始的值， 应该是这些值中的一个。

## ◆ GetPathData()

OFDPathData foxit::ofd::graphics::OFDPathObject::GetPathData | ( |  | ) |

获取路径数据对象。

返回
  路径数据对象。

## ◆ IsEmpty()

bool foxit::ofd::graphics::OFDPathObject::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ IsFill()

bool foxit::ofd::graphics::OFDPathObject::IsFill | ( |  | ) |

判断路径对象填充属性。

返回
  true表示有填充，false表示没有填充。

## ◆ IsStroke()

bool foxit::ofd::graphics::OFDPathObject::IsStroke | ( |  | ) |

判断路径对象描边属性。

返回
  true表示描边，false表示没有描边。

## ◆ operator !=()

bool foxit::ofd::graphics::OFDPathObject::operator != | ( | const OFDPathObject & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个OFD路径对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

OFDPathObject& foxit::ofd::graphics::OFDPathObject::operator= | ( | const OFDPathObject & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个OFD路径对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::ofd::graphics::OFDPathObject::operator== | ( | const OFDPathObject & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个OFD路径对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。

## ◆ SetAbbreviatedData()

void foxit::ofd::graphics::OFDPathObject::SetAbbreviatedData | ( | const String & | abbreviated_data | ) |

设置路径对象中路径元素描述序列。

参数

  [in] | abbreviated_data | 路径元素描述序列。

返回
  无。

## ◆ SetFill()

void foxit::ofd::graphics::OFDPathObject::SetFill | ( | bool | fill | ) |

设置路径对象填充属性。

参数

  [in] | fill | 填充属性。true表示填充，false表示不填充。

返回
  无。

## ◆ SetFillMode()

void foxit::ofd::graphics::OFDPathObject::SetFillMode | ( | PathFillMode | fill_mode = `e_PathFillNonZero` | ) |

设置路径对象填充模式。

参数

  [in] | fill_mode | 填充模式。请参考从 foxit::ofd::graphics::OFDPathObject::e_PathFillNonZero 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetPathData()

void foxit::ofd::graphics::OFDPathObject::SetPathData | ( | const OFDPathData & | path | ) |

设置路径数据对象。

参数

  [in] | path | 路径数据对象。

返回
  无。

## ◆ SetStroke()

void foxit::ofd::graphics::OFDPathObject::SetStroke | ( | bool | stroke | ) |

设置路径对象描边属性。

参数

  [in] | stroke | 描边属性。true表示描边，false表示不描边。

返回
  无。