Foxit PDF SDK
fsdk.SnapPointMgr Class Reference

Public Member Functions

def GetSnappedPointAtPos (position, flags)
 Get the snapped point information at/around a specified position in [PDF coordinate system] ().
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 
def Reload ()
 Reload current manager.
More...
 

Detailed Description

This class represents a manager for snapping point. This class can be used to snap point in a path with specified snapping flags.

Member Function Documentation

◆ GetSnappedPointAtPos()

def fsdk.SnapPointMgr.GetSnappedPointAtPos (   position,
  flags 
)

Get the snapped point information at/around a specified position in [PDF coordinate system] ().

Parameters
[in]positionA specified position, in [PDF coordinate system] ().
[in]flagsFlags for snapping point. Please refer to values starting from fsdk.SnapPointMgrE_FlagEndpoint and this should be one or a combination of these values.
Returns
Information for a snapped point. If the return value of function fsdk.SnappedPoint.IsEmpty for the returned snapped point object is true, that means no suitable point can be snapped.

◆ IsEmpty()

def fsdk.SnapPointMgr.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ Reload()

def fsdk.SnapPointMgr.Reload ( )

Reload current manager.

This function should be called after any path in related PDF page has been modified.

Returns
None.