NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IGL2DExcludeClipRule Class Referenceabstract

Implementation of "Exclude" clip rule. More...

#include <gl2d_clip_rule_interface.h>

Inheritance diagram for IGL2DExcludeClipRule:
IGL2DClipRule

Public Member Functions

virtual SDKResult SDK_CALLTYPE SetMesh (const IGL2DMeshSP &mesh_to_clip, const SDKMatrix3X2 &objects_transformation, const SDKMatrix3X2 &canvas_transformation)=0 throw ()
 Sets new main mesh (or mesh collection) to clip by exclude meshes No-clip area is given mesh except all of exclude meshes objects_transformation matrix and canvas_transformation should specify appropriate mesh transformation. If canvas transformation will be changed later, it does not affects to given mesh transformation.
 
virtual SDKResult SDK_CALLTYPE SetMesh (const IGL2DMeshSP &mesh_to_clip)=0 throw ()
 Sets new main mesh (or mesh collection) to clip by exclude meshes No-clip area is given mesh except all of exclude meshes Same as SetMesh/SetMeshColl, but objects_transformation and canvas_transformation matrix will be taken from canvas during call. More...
 
SDKResult SDK_CALLTYPE ResetMesh ()
 Removes previously applied main mesh to clip, clip rule becomes empty.
 
virtual SDKResult SDK_CALLTYPE PushExcludeMesh (const IGL2DMeshSP &exclude_mesh, const SDKMatrix3X2 &objects_transformation, const SDKMatrix3X2 &canvas_transformation)=0 throw ()
 Adds new exclude mesh (or meshes collection) to exclude meshes stack. objects_transformation matrix and canvas_transformation should specify appropriate mesh transformation. If canvas transformation will be changed later, it does not affects to given mesh transformation.
 
virtual SDKResult SDK_CALLTYPE PushExcludeMesh (const IGL2DMeshSP &exclude_mesh)=0 throw ()
 Adds new exclude mesh (or meshes collection) to exclude meshes stack. Same as PushExcludeMesh/PushExcludeMeshColl, but objects_transformation and canvas_transformation matrix will be taken from canvas during call.
 
virtual SDKResult SDK_CALLTYPE PopExcludeMesh ()=0 throw ()
 Removes latest exclude mesh (or meshes collection) from exclude meshes stack.
 
virtual SDKResult SDK_CALLTYPE ResetExcludeMeshes ()=0 throw ()
 Removes all of exclude meshes from stack.
 
virtual SDKUInt32 SDK_CALLTYPE GetExcludeMeshesCount () const =0 throw ()
 Returns number of exclude meshes applied so far.
 
virtual SDKResult SDK_CALLTYPE Clear ()=0 throw ()
 Clears up given rule, rule becomes empty.
 
- Public Member Functions inherited from IGL2DClipRule
virtual void SDK_CALLTYPE Dump () const =0 throw ()
 Dumps given object.
 
virtual IGL2DCanvasSP SDK_CALLTYPE GetParent () const =0 throw ()
 Returns parent canvas object.
 
virtual GL2DClipRuleType SDK_CALLTYPE GetType () const =0 throw ()
 Returns clip rule type.
 
virtual bool SDK_CALLTYPE IsEmpty () const =0 throw ()
 Checks, if given clip rule is empty (does not have any clip entries)
 

Detailed Description

Implementation of "Exclude" clip rule.

Member Function Documentation

◆ SetMesh()

virtual SDKResult SDK_CALLTYPE SetMesh ( const IGL2DMeshSP &  mesh_to_clip)
throw (
)
pure virtual

Sets new main mesh (or mesh collection) to clip by exclude meshes No-clip area is given mesh except all of exclude meshes Same as SetMesh/SetMeshColl, but objects_transformation and canvas_transformation matrix will be taken from canvas during call.

SDKResult SetMesh(const IGL2DMeshSP& mesh_to_clip) throw() { SDKMatrix3X2 objects_transformation; canvas->GetObjectsTransformationMatrix(objects_transformation);

SDKMatrix3X2 canvas_transformation; canvas->GetObjectsTransformationMatrix(canvas_transformation);

return SetMesh(mesh_to_clip, objects_transformation, canvas_transformation); }


The documentation for this class was generated from the following file: