a2dClipPathProperty Class Reference
[a2dPropObject holds property objects, objects used for styling a2dCanvasObject's]
Clipping Path property that can be added to a2dCanvasObject's.
More...
#include <canprop.h>
Inheritance diagram for a2dClipPathProperty:
Collaboration diagram for a2dClipPathProperty:
Public Member Functions | |
| a2dClipPathProperty (const a2dPropertyIdCanvasClipPath *id, a2dPolygonL *clip) | |
| a2dClipPathProperty (const a2dClipPathProperty &other, a2dObject::CloneOptions options) | |
| a2dNamedProperty * | Clone (a2dObject::CloneOptions options) const |
| Virtual copy constructor. | |
| void | Assign (const a2dNamedProperty &other) |
| Virtual assignment operator. | |
| virtual a2dPolygonL * | GetClipObject () const |
| return a2dPolygonL that is used for clipping | |
| void | SetCanvasObject (a2dPolygonL *clip) |
| set object to use for clipping | |
| void | PushClip (a2dCanvasView *drawer, a2dBooleanClip clipoperation=a2dCLIP_AND) |
| void | PopClip (a2dCanvasView *drawer) |
| virtual void | SetVisible (bool visible) |
| the object is visible or not. | |
| virtual bool | GetVisible () const |
| return true if the object is visible. | |
| void | SetCanRender (bool render) |
| if object can be rendered or not. | |
| bool | GetCanRender () const |
| return true if the object can be rendered. | |
| virtual a2dObject * | GetRefObject () const |
| when a2dProperty, return its value else assert | |
| virtual a2dObject * | GetRefObjectNA () const |
| when a2dProperty, return its value else return NULL | |
Protected Member Functions | |
| void | DoWalker (wxObject *parent, a2dWalkerIOHandler &handler) |
| void | DoRender (a2dIterC &ic, a2dAffineMatrix *cworld, OVERLAP clipparent, int layer, a2dCanvasObjectFlagsMask mask) |
| virtual void | DoSave (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList *towrite) |
| Save settings. | |
| virtual void | DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts) |
| Load settings. | |
Protected Attributes | |
| a2dSmrtPtr< a2dPolygonL > | m_clip |
| bool | m_visible |
| see SetVisible() | |
| bool | m_render |
| in case of a grahics application, should this property be rendered. | |
Detailed Description
Clipping Path property that can be added to a2dCanvasObject's.Used during rendering to set a clipping path on a a2dCanvasObject. Everything outside the area defined by the clipping polygon is not drawn.
- Remarks:
- Currently only clipping object of type a2dPolygonL is supported.
the clipping object itself can also be rendered by adding it to the children of the object being clipped. Like any Object it has to be set visible to see it.
Definition at line 313 of file canprop.h.
Member Function Documentation
| virtual void a2dClipPathProperty::SetVisible | ( | bool | visible | ) | [inline, virtual] |
| void a2dClipPathProperty::SetCanRender | ( | bool | render | ) | [inline] |
if object can be rendered or not.
some properties have a reference to a a2dCanvasObject, but only to store it, not to render it as part of the object.
The documentation for this class was generated from the following files: