Foxit PDF SDK
foxit::ofd::graphics::OFDGraphicsObject类 参考
类 foxit::ofd::graphics::OFDGraphicsObject 继承关系图:
foxit::Base foxit::ofd::graphics::OFDCompositeObject foxit::ofd::graphics::OFDImageObject foxit::ofd::graphics::OFDPathObject foxit::ofd::graphics::OFDTextObject foxit::ofd::graphics::OFDVideoObject foxit::ofd::OFDLayer foxit::ofd::graphics::OFDBlockObject

Public 类型

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 成员函数

 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
 不相等操作符。 更多...
 
OFDGraphicsObjectoperator= (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图元对象相关的方法。

成员枚举类型说明

◆ LineCapMode

OFD线端点样式枚举。

该枚举值应单独使用。

枚举值
e_LineCapButt 

平头端盖。描边在路径的端点处被切断。路径末端之外没有投影。

e_LineCapRound 

圆头端盖。在端点周围绘制一个直径等于线宽的半圆弧并填充。

e_LineCapSquare 

投影方形端盖。描边在路径端点之外继续延伸等于线宽一半的距离,并被切断。

◆ LineJoinMode

OFD线条连接样式枚举。

该枚举值应单独使用。

枚举值
e_LineJoinMiter 

斜接线条连接类型。

两段描边的外边缘延伸直到它们以一定角度相交。

e_LineJoinRound 

圆角线条连接类型。

在两段相交的点周围绘制一个直径等于线宽的圆弧, 连接两段描边的外边缘。

e_LineJoinBevel 

斜角线条连接类型。

两段使用平头端盖完成,并且段末端之外的结果凹口 用三角形填充。

◆ ObjectType

OFD图元对象类型定义枚举类型.

该枚举值应单独使用.

枚举值
e_ObjectTypeUnknown 

对象类型:未知

e_ObjectTypePageBlock 

对象类型:页面块。

e_ObjectTypeComposite 

对象类型:组合。

e_ObjectTypeSVG 

对象类型:矢量图形。

e_ObjectTypeText 

对象类型:文字。

e_ObjectTypePath 

对象类型:路径。

e_ObjectTypeImage 

对象类型:图像。

e_ObjectTypeVideo 

对象类型:视频。

构造及析构函数说明

◆ OFDGraphicsObject()

foxit::ofd::graphics::OFDGraphicsObject::OFDGraphicsObject ( const OFDGraphicsObject other)

构造函数,通过另一个OFD图元对象。

参数
[in]other另一个OFD图元对象。

成员函数说明

◆ CreateActions()

Actions foxit::ofd::graphics::OFDGraphicsObject::CreateActions ( )

创建图元对象动作集合对象。

返回
返回图元对象动作集合对象。

◆ GetActions()

Actions foxit::ofd::graphics::OFDGraphicsObject::GetActions ( )

获取图元对象的动作集合。

返回
返回动作数组对象集合对象。

◆ GetAlpha()

foxit::uint8 foxit::ofd::graphics::OFDGraphicsObject::GetAlpha ( )

获取图元对象alpha属性。

返回
alpha值(0-255)。

◆ GetBorderInfo()

BorderInfo foxit::ofd::graphics::OFDGraphicsObject::GetBorderInfo ( )

获取图元对象边框信息(只有Image和Video对象可能会存在边框)。

返回
图元对象边框信息值。

◆ GetBoundary()

foxit::RectF foxit::ofd::graphics::OFDGraphicsObject::GetBoundary ( )

获取图元对象矩形外接框。

返回
矩形外接框值。坐标系为OFD坐标系。

◆ GetDashOffset()

float foxit::ofd::graphics::OFDGraphicsObject::GetDashOffset ( )

获取图元对象虚线重复样式。

返回
图元对象虚线重复样式值。

◆ GetDashPattern()

foxit::FloatArray foxit::ofd::graphics::OFDGraphicsObject::GetDashPattern ( )

获取图元对象虚线重复样式数组。

返回
图元对象虚线重复样式数组值。

◆ GetFillColor()

foxit::RGB foxit::ofd::graphics::OFDGraphicsObject::GetFillColor ( )

获取图元对象填充颜色。

返回
颜色值。

◆ GetID()

foxit::uint32 foxit::ofd::graphics::OFDGraphicsObject::GetID ( )

获取图元对象资源ID。

返回
图元对象资源ID值。

◆ GetLineCap()

LineCapMode foxit::ofd::graphics::OFDGraphicsObject::GetLineCap ( )

获取图元对象线帽样式。

返回
线帽样式值。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_LineCapButt 开始的值, 应该是这些值中的一个。

◆ GetLineJoin()

LineJoinMode foxit::ofd::graphics::OFDGraphicsObject::GetLineJoin ( )

获取线条连接样式。

返回
线条连接样式值。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_LineJoinMiter 开始的值, 应该是这些值中的一个。

◆ GetLineWidth()

float foxit::ofd::graphics::OFDGraphicsObject::GetLineWidth ( )

获取图元对象线宽。

返回
线宽值(单位毫米)。

◆ GetMatrix()

foxit::Matrix foxit::ofd::graphics::OFDGraphicsObject::GetMatrix ( )

获取图元对象矩阵。

返回
矩阵值。

◆ GetMiterLimit()

float foxit::ofd::graphics::OFDGraphicsObject::GetMiterLimit ( )

获取图元对象斜切限制值。

返回
斜切限制值。

◆ GetName()

String foxit::ofd::graphics::OFDGraphicsObject::GetName ( )

获取图元对象名称。

返回
图元对象名称值。

◆ GetPageIndex()

int foxit::ofd::graphics::OFDGraphicsObject::GetPageIndex ( )

获取图元对象所在页面的索引号。

返回
图元对象所在页面的索引号(由0开始编号)。

◆ GetStrokeColor()

foxit::RGB foxit::ofd::graphics::OFDGraphicsObject::GetStrokeColor ( )

获取图元对象勾边颜色。

返回
颜色值。

◆ GetType()

ObjectType foxit::ofd::graphics::OFDGraphicsObject::GetType ( )

获取图元对象类型。

返回
图元对象类型。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypeUnknown 开始的值, 应该是这些值中的一个。

◆ HasBorder()

bool foxit::ofd::graphics::OFDGraphicsObject::HasBorder ( )

判断图元对象是否有边框。

返回
true表示有边框,false表示无边框。

◆ IsEmpty()

bool foxit::ofd::graphics::OFDGraphicsObject::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ IsVisible()

bool foxit::ofd::graphics::OFDGraphicsObject::IsVisible ( )

获取图元对象可见性属性。

返回
true表示可见,false表示不可见。

◆ operator !=()

bool foxit::ofd::graphics::OFDGraphicsObject::operator != ( const OFDGraphicsObject other) const

不相等操作符。

参数
[in]other另一个OFD图元对象。此函数将检查当前对象是否不等于这个对象。
返回
true 表示不相等,false 表示相等。

◆ operator=()

OFDGraphicsObject& foxit::ofd::graphics::OFDGraphicsObject::operator= ( const OFDGraphicsObject other)

赋值操作符。

参数
[in]other另一个OFD图元对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::ofd::graphics::OFDGraphicsObject::operator== ( const OFDGraphicsObject other) const

相等操作符。

参数
[in]other另一个OFD图元对象。此函数将检查当前对象是否等于这个对象。
返回
true 表示相等,false 表示不相等。

◆ SetAlpha()

void foxit::ofd::graphics::OFDGraphicsObject::SetAlpha ( foxit::uint8  alpha)

设置图元对象alpha属性。

参数
[in]alphaalpha值(0-255)。
返回
无。

◆ SetBorderInfo()

void foxit::ofd::graphics::OFDGraphicsObject::SetBorderInfo ( const BorderInfo border_info)

设置图元对象边框信息。

参数
[in]border_info图元对象边框信息值。
返回
无。

◆ SetBoundary()

void foxit::ofd::graphics::OFDGraphicsObject::SetBoundary ( const RectF boundary)

设置图元对象矩形外接框。

参数
[in]boundary矩形外接框值。
返回
无。

◆ SetDashOffset()

void foxit::ofd::graphics::OFDGraphicsObject::SetDashOffset ( float  dash_offset)

设置图元对象虚线重复样式起始值。

参数
[in]dash_offset图元对象虚线重复起始值。
返回
无。

◆ SetDashPattern()

void foxit::ofd::graphics::OFDGraphicsObject::SetDashPattern ( float  dash_offset,
const foxit::FloatArray dash_offset_array 
)

设置图元对象虚线重复样式。

参数
[in]dash_offset图元对象虚线重复起始值。
[in]dash_offset_array重复样式点数据数组,数组大小为2,其中第一个元素表示虚线长度,第二个元素表示虚线间隔的长度。
返回
无。

◆ SetFillColor()

void foxit::ofd::graphics::OFDGraphicsObject::SetFillColor ( foxit::uint32  fill_color)

设置图元对象填充颜色。

参数
[in]fill_color颜色值。
返回
无。

◆ SetLineCap()

void foxit::ofd::graphics::OFDGraphicsObject::SetLineCap ( LineCapMode  line_cap = e_LineCapButt)

设置图元对象线帽样式。

参数
[in]line_cap线帽样式值(默认为e_LineCapButt)。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_LineCapButt 开始的值, 应该是这些值中的一个。
返回
无。

◆ SetLineJoin()

void foxit::ofd::graphics::OFDGraphicsObject::SetLineJoin ( LineJoinMode  line_join = e_LineJoinMiter)

设置线条连接样式。

参数
[in]line_join样式值。(默认为e_LineJoinMiter)。请参考从 foxit::ofd::graphics::OFDGraphicsObject::e_LineJoinMiter 开始的值, 应该是这些值中的一个。
返回
无。

◆ SetLineWidth()

void foxit::ofd::graphics::OFDGraphicsObject::SetLineWidth ( float  line_width)

设置图元对象线宽。

参数
[in]line_width线宽值(单位毫米)。
返回
无。

◆ SetMatrix()

void foxit::ofd::graphics::OFDGraphicsObject::SetMatrix ( const Matrix mt)

设置图元对象矩阵。

参数
[in]mt矩阵。
返回
无。

◆ SetMiterLimit()

void foxit::ofd::graphics::OFDGraphicsObject::SetMiterLimit ( float  miter_limit)

设置图元对象斜切限制值。

参数
[in]miter_limit斜切限制值。
返回
无。

◆ SetName()

void foxit::ofd::graphics::OFDGraphicsObject::SetName ( const String name)

设置图元对象名称。

参数
[in]name图元对象名称值。
返回
无。

◆ SetStrokeColor()

void foxit::ofd::graphics::OFDGraphicsObject::SetStrokeColor ( foxit::uint32  stroke_color)

设置图元对象勾边颜色。

参数
[in]stroke_color颜色值。
返回
无。

◆ SetVisible()

void foxit::ofd::graphics::OFDGraphicsObject::SetVisible ( bool  visible)

设置图元对象可见性属性。

参数
[in]visible是否可见(true可见,false不可见)。
返回
无。