Foxit PDF SDK
foxit::addon::pdf3d::PDF3DAnnotInstance类 参考
类 foxit::addon::pdf3d::PDF3DAnnotInstance 继承关系图:
foxit::Base

Public 类型

enum  PDF3DController {
  e_ControllerRotate = 0, e_ControllerSpin = 1, e_ControllerPan = 2, e_ControllerZoom = 3,
  e_ControllerWalk = 4, e_ControllerFly = 5
}
 3D控制器工具的枚举。 更多...
 
enum  PDF3DRenderMode {
  e_RenderModeSolid = 1, e_RenderModeSolidWireframe = 2, e_RenderModeSolidOutline = 3, e_RenderModeTransparent = 4,
  e_RenderModeTransparentWireframe = 5, e_RenderModeBoundingBox = 6, e_RenderModeTransparentBoundingBox = 7, e_RenderModeTransparentBoundingBoxOutline = 8,
  e_RenderModeWireframe = 9, e_RenderModeShadedWireframe = 10, e_RenderModeHiddenWireframe = 11, e_RenderModeIllustration = 12,
  e_RenderModeShadedIllustration = 13, e_RenderModeVertices = 14, e_RenderModeShadedVertices = 15
}
 3D渲染模式的枚举。 更多...
 

Public 成员函数

 PDF3DAnnotInstance ()
 构造函数。
 
 PDF3DAnnotInstance (const PDF3DAnnotInstance &other)
 带另一个3D注释实例对象的构造函数。 更多...
 
 ~PDF3DAnnotInstance ()
 析构函数。
 
FX_HWND ActivateCanvas (FX_HWND screen_canvas_parent)
 激活画布。 更多...
 
void ApplyPresetView (const PDF3DAnnotViewData &view_data)
 应用预设视图。 更多...
 
pdf::annots::Annot GetAnnot ()
 获取关联的注释。 更多...
 
PDF3DAnnotViewDataArray GetPresetViewList ()
 获取3D模型中所有预设视图的列表。 更多...
 
ModelNode GetRootNode ()
 获取3D模型树结构的根节点。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
void OnLButtonDown (int flag, PointF point)
 按下左键时调用此函数。 更多...
 
void OnLButtonUp (int flag, PointF point)
 释放左键时调用此函数。 更多...
 
void OnMouseMove (int flag, PointF point)
 移动鼠标时调用此函数。 更多...
 
void OnMouseWheel (int flag, int delta, PointF point)
 滚动鼠标滚轮时调用此函数。 更多...
 
void OnRButtonDown (int flag, PointF point)
 按下右键时调用此函数。 更多...
 
void OnRButtonUp (int flag, PointF point)
 释放右键时调用此函数。 更多...
 
bool operator!= (const PDF3DAnnotInstance &other) const
 不相等操作符。 更多...
 
PDF3DAnnotInstanceoperator= (const PDF3DAnnotInstance &other)
 赋值操作符。 更多...
 
bool operator== (const PDF3DAnnotInstance &other) const
 相等操作符。 更多...
 
void ResetDefaultView ()
 将视图重置为默认视图,3D模型将重置为其默认状态。 更多...
 
void SetController (PDF3DController tool_tag)
 设置控制器。 更多...
 
void SetRenderMode (PDF3DRenderMode render_mode)
 设置模型渲染模式。 更多...
 
void UpdateCanvas (RectI rect)
 更新画布。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类代表3D 注释实例。

参见
PDF3DContext

成员枚举类型说明

◆ PDF3DController

3D控制器工具的枚举。

此枚举的值应该单独使用。

枚举值
e_ControllerRotate 

旋转。

e_ControllerSpin 

自旋。

e_ControllerPan 

平移。

e_ControllerZoom 

缩放。

e_ControllerWalk 

步行。

e_ControllerFly 

飞行。

◆ PDF3DRenderMode

3D渲染模式的枚举。

此枚举的值应该单独使用。

枚举值
e_RenderModeSolid 

实体。

e_RenderModeSolidWireframe 

实体线框。

e_RenderModeSolidOutline 

实体轮廓。

e_RenderModeTransparent 

透明。

e_RenderModeTransparentWireframe 

透明线框。

e_RenderModeBoundingBox 

边界框。

e_RenderModeTransparentBoundingBox 

透明边界框。

e_RenderModeTransparentBoundingBoxOutline 

透明边界框轮廓。

e_RenderModeWireframe 

线框。

e_RenderModeShadedWireframe 

阴影线框。

e_RenderModeHiddenWireframe 

隐藏线框。

e_RenderModeIllustration 

插图。

e_RenderModeShadedIllustration 

阴影插图。

e_RenderModeVertices 

顶点。

e_RenderModeShadedVertices 

阴影顶点。

构造及析构函数说明

◆ PDF3DAnnotInstance()

foxit::addon::pdf3d::PDF3DAnnotInstance::PDF3DAnnotInstance ( const PDF3DAnnotInstance other)

带另一个3D注释实例对象的构造函数。

参数
[in]other另一个3D注释实例对象。

成员函数说明

◆ ActivateCanvas()

FX_HWND foxit::addon::pdf3d::PDF3DAnnotInstance::ActivateCanvas ( FX_HWND  screen_canvas_parent)

激活画布。

参数
[in]screen_canvas_parent用于激活画布的父窗口句柄。
返回
画布句柄。

◆ ApplyPresetView()

void foxit::addon::pdf3d::PDF3DAnnotInstance::ApplyPresetView ( const PDF3DAnnotViewData view_data)

应用预设视图。

确保已调用ActivateCanvas函数。

参数
[in]view_data要设置的视图数据。应为GetPresetViewList函数返回的数据数组中的一个。
返回
无。

◆ GetAnnot()

pdf::annots::Annot foxit::addon::pdf3d::PDF3DAnnotInstance::GetAnnot ( )

获取关联的注释。

返回
注释对象。

◆ GetPresetViewList()

PDF3DAnnotViewDataArray foxit::addon::pdf3d::PDF3DAnnotInstance::GetPresetViewList ( )

获取3D模型中所有预设视图的列表。

确保已调用ActivateCanvas函数。

返回
视图数据数组。

◆ GetRootNode()

ModelNode foxit::addon::pdf3d::PDF3DAnnotInstance::GetRootNode ( )

获取3D模型树结构的根节点。

确保函数 PDF3DAnnotInstance::ActivateCanvas 已经被调用。

返回
3D模型结构树根节点。

◆ IsEmpty()

bool foxit::addon::pdf3d::PDF3DAnnotInstance::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ OnLButtonDown()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnLButtonDown ( int  flag,
PointF  point 
)

按下左键时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]point鼠标的位置。
返回
无。

◆ OnLButtonUp()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnLButtonUp ( int  flag,
PointF  point 
)

释放左键时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]point鼠标的位置。
返回
无。

◆ OnMouseMove()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnMouseMove ( int  flag,
PointF  point 
)

移动鼠标时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]point鼠标的位置。
返回
无。

◆ OnMouseWheel()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnMouseWheel ( int  flag,
int  delta,
PointF  point 
)

滚动鼠标滚轮时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]delta鼠标滚轮的增量。
[in]point鼠标的位置。
返回
无。

◆ OnRButtonDown()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnRButtonDown ( int  flag,
PointF  point 
)

按下右键时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]point鼠标的位置。
返回
无。

◆ OnRButtonUp()

void foxit::addon::pdf3d::PDF3DAnnotInstance::OnRButtonUp ( int  flag,
PointF  point 
)

释放右键时调用此函数。

确保已调用ActivateCanvas函数。

参数
[in]flag鼠标事件的标志。
[in]point鼠标的位置。
返回
无。

◆ operator!=()

bool foxit::addon::pdf3d::PDF3DAnnotInstance::operator!= ( const PDF3DAnnotInstance other) const

不相等操作符。

参数
[in]other另一个3D注释实例对象。此函数将检查当前对象是否不等于此对象。
返回
true表示不相等,false表示相等。

◆ operator=()

PDF3DAnnotInstance& foxit::addon::pdf3d::PDF3DAnnotInstance::operator= ( const PDF3DAnnotInstance other)

赋值操作符。

参数
[in]other另一个3D注释实例对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::addon::pdf3d::PDF3DAnnotInstance::operator== ( const PDF3DAnnotInstance other) const

相等操作符。

参数
[in]other另一个3D注释实例对象。此函数将检查当前对象是否等于此对象。
返回
true表示相等,false表示不相等。

◆ ResetDefaultView()

void foxit::addon::pdf3d::PDF3DAnnotInstance::ResetDefaultView ( )

将视图重置为默认视图,3D模型将重置为其默认状态。

确保已调用ActivateCanvas函数。

返回
无。

◆ SetController()

void foxit::addon::pdf3d::PDF3DAnnotInstance::SetController ( PDF3DController  tool_tag)

设置控制器。

确保已调用ActivateCanvas函数。

参数
[in]tool_tag要设置的控制器工具。请参考从PDF3DAnnotInstance::e_ControllerRotate 开始的值,这应该是这些值中的一个。
默认值:PDF3DAnnotInstance::e_ControllerRotate
返回
无。

◆ SetRenderMode()

void foxit::addon::pdf3d::PDF3DAnnotInstance::SetRenderMode ( PDF3DRenderMode  render_mode)

设置模型渲染模式。

确保已调用ActivateCanvas函数。

参数
[in]render_mode要设置的渲染模式。请参考从PDF3DAnnotInstance::e_RenderModeSolid 开始的值,这应该是这些值中的一个。
默认值:PDF3DAnnotInstance::e_RenderModeSolidOutline
返回
无。

◆ UpdateCanvas()

void foxit::addon::pdf3d::PDF3DAnnotInstance::UpdateCanvas ( RectI  rect)

更新画布。

确保已调用ActivateCanvas函数。 当画布大小和位置需要更新时调用此函数。

参数
[in]rect设备坐标系统中画布的新区域。
返回
无。