Foxit PDF SDK
|
Public Types | |
enum | PDF3DController { e_ControllerRotate = 0, e_ControllerSpin = 1, e_ControllerPan = 2, e_ControllerZoom = 3, e_ControllerWalk = 4, e_ControllerFly = 5 } |
Enumeration for the 3D controller tool. More... | |
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 } |
Enumeration for the 3D render mode. More... | |
Public Member Functions | |
PDF3DAnnotInstance () | |
Constructor. | |
PDF3DAnnotInstance (const PDF3DAnnotInstance &other) | |
Constructor, with another 3d annot instance object. More... | |
~PDF3DAnnotInstance () | |
Destructor. | |
FX_HWND | ActivateCanvas (FX_HWND screen_canvas_parent) |
Activate canvas. More... | |
void | ApplyPresetView (const PDF3DAnnotViewData &view_data) |
Apply the preset view . More... | |
pdf::annots::Annot | GetAnnot () |
Get associated annotation. More... | |
PDF3DAnnotViewDataArray | GetPresetViewList () |
Get the list of all preset views in the 3D model. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
void | OnLButtonDown (int flag, PointF point) |
Call this function when pressing the left button. More... | |
void | OnLButtonUp (int flag, PointF point) |
Call this function when releasing the left button. More... | |
void | OnMouseMove (int flag, PointF point) |
Call this function when moving the mouse. More... | |
void | OnMouseWheel (int flag, int delta, PointF point) |
Call this function when scrolling the mouse wheel. More... | |
void | OnRButtonDown (int flag, PointF point) |
Call this function when pressing the right button. More... | |
void | OnRButtonUp (int flag, PointF point) |
Call this function when releasing the right button. More... | |
bool | operator!= (const PDF3DAnnotInstance &other) const |
Not equal operator. More... | |
PDF3DAnnotInstance & | operator= (const PDF3DAnnotInstance &other) |
Assign operator. More... | |
bool | operator== (const PDF3DAnnotInstance &other) const |
Equal operator. More... | |
void | ResetDefaultView () |
Reset the view back to the default view, the 3D model will be reset to its default state. More... | |
void | SetController (PDF3DController tool_tag) |
Set controller. More... | |
void | SetRenderMode (PDF3DRenderMode render_mode) |
Set model render mode. More... | |
void | UpdateCanvas (RectI rect) |
Update the canvas. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents a 3D annotation instance.
Enumeration for the 3D render mode.
Values of this enumeration should be used alone.
foxit::addon::pdf3d::PDF3DAnnotInstance::PDF3DAnnotInstance | ( | const PDF3DAnnotInstance & | other | ) |
Constructor, with another 3d annot instance object.
[in] | other | Another 3d annot instance object. |
Activate canvas.
[in] | screen_canvas_parent | The parent window handle used to activate the canvas. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::ApplyPresetView | ( | const PDF3DAnnotViewData & | view_data | ) |
Apply the preset view .
Ensure the function ActivateCanvas has been called.
[in] | view_data | The data of the view to be set. It should be one of the data array returned by function GetPresetViewList. |
pdf::annots::Annot foxit::addon::pdf3d::PDF3DAnnotInstance::GetAnnot | ( | ) |
Get associated annotation.
PDF3DAnnotViewDataArray foxit::addon::pdf3d::PDF3DAnnotInstance::GetPresetViewList | ( | ) |
Get the list of all preset views in the 3D model.
Ensure the function ActivateCanvas has been called.
bool foxit::addon::pdf3d::PDF3DAnnotInstance::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnLButtonDown | ( | int | flag, |
PointF | point | ||
) |
Call this function when pressing the left button.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | point | The point of the mouse. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnLButtonUp | ( | int | flag, |
PointF | point | ||
) |
Call this function when releasing the left button.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | point | The point of the mouse. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnMouseMove | ( | int | flag, |
PointF | point | ||
) |
Call this function when moving the mouse.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | point | The point of the mouse. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnMouseWheel | ( | int | flag, |
int | delta, | ||
PointF | point | ||
) |
Call this function when scrolling the mouse wheel.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | delta | The delta of the mouse wheel. |
[in] | point | The point of the mouse. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnRButtonDown | ( | int | flag, |
PointF | point | ||
) |
Call this function when pressing the right button.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | point | The point of the mouse. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::OnRButtonUp | ( | int | flag, |
PointF | point | ||
) |
Call this function when releasing the right button.
Ensure the function ActivateCanvas has been called.
[in] | flag | The flag of the mouse event. |
[in] | point | The point of the mouse. |
bool foxit::addon::pdf3d::PDF3DAnnotInstance::operator!= | ( | const PDF3DAnnotInstance & | other | ) | const |
Not equal operator.
[in] | other | Another 3d annot instance object. This function will check if current object is not equal to this one. |
PDF3DAnnotInstance& foxit::addon::pdf3d::PDF3DAnnotInstance::operator= | ( | const PDF3DAnnotInstance & | other | ) |
Assign operator.
[in] | other | Another 3d annot instance object, whose value would be assigned to current object. |
bool foxit::addon::pdf3d::PDF3DAnnotInstance::operator== | ( | const PDF3DAnnotInstance & | other | ) | const |
Equal operator.
[in] | other | Another 3d annot instance object. This function will check if current object is equal to this one. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::ResetDefaultView | ( | ) |
Reset the view back to the default view, the 3D model will be reset to its default state.
Ensure the function ActivateCanvas has been called.
void foxit::addon::pdf3d::PDF3DAnnotInstance::SetController | ( | PDF3DController | tool_tag | ) |
Set controller.
Ensure the function ActivateCanvas has been called.
[in] | tool_tag | The controller tool to be set. Please refer to values starting from PDF3DAnnotInstance::e_ControllerRotate and this should be one of these values. Default value: PDF3DAnnotInstance::e_ControllerRotate. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::SetRenderMode | ( | PDF3DRenderMode | render_mode | ) |
Set model render mode.
Ensure the function ActivateCanvas has been called.
[in] | render_mode | The render mode to be set. Please refer to values starting from PDF3DAnnotInstance::e_RenderModeSolid and this should be one of these values. Default value: PDF3DAnnotInstance::e_RenderModeSolidOutline. |
void foxit::addon::pdf3d::PDF3DAnnotInstance::UpdateCanvas | ( | RectI | rect | ) |
Update the canvas.
Ensure the function ActivateCanvas has been called. Call this function when the canvas size and position need to be updated.
[in] | rect | The new area of canvas in device coordinate system. |