LibreOffice Module drawinglayer (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
drawinglayer::primitive2d::HelplinePrimitive2D Class Referencefinal

HelplinePrimitive2D class. More...

#include <helplineprimitive2d.hxx>

Inheritance diagram for drawinglayer::primitive2d::HelplinePrimitive2D:
[legend]
Collaboration diagram for drawinglayer::primitive2d::HelplinePrimitive2D:
[legend]

Public Member Functions

 HelplinePrimitive2D (const basegfx::B2DPoint &rPosition, const basegfx::B2DVector &rDirection, HelplineStyle2D eStyle, const basegfx::BColor &rRGBColA, const basegfx::BColor &aRGBColB, double fDiscreteDashLength)
 constructor More...
 
const basegfx::B2DPointgetPosition () const
 data read access More...
 
const basegfx::B2DVectorgetDirection () const
 
HelplineStyle2D getStyle () const
 
const basegfx::BColorgetRGBColA () const
 
const basegfx::BColorgetRGBColB () const
 
double getDiscreteDashLength () const
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const override
 compare operator More...
 
virtual sal_uInt32 getPrimitive2DID () const override
 provide unique ID More...
 
virtual void get2DDecomposition (Primitive2DDecompositionVisitor &rVisitor, const geometry::ViewInformation2D &rViewInformation) const override
 Override standard getDecomposition to be view-dependent here. More...
 
- Public Member Functions inherited from drawinglayer::primitive2d::BufferedDecompositionPrimitive2D
 BufferedDecompositionPrimitive2D ()
 
virtual void get2DDecomposition (Primitive2DDecompositionVisitor &rVisitor, const geometry::ViewInformation2D &rViewInformation) const override
 The getDecomposition default implementation will on demand use create2DDecomposition() if maBuffered2DDecomposition is empty. More...
 
void setTransparenceForShadow (sal_uInt16 nTransparenceForShadow)
 
sal_uInt16 getTransparenceForShadow () const
 
- Public Member Functions inherited from drawinglayer::primitive2d::BasePrimitive2D
 BasePrimitive2D ()
 
virtual ~BasePrimitive2D () override
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const
 the ==operator is mainly needed to allow testing newly-created primitives against their last incarnation which buffers/holds the made decompositions. More...
 
bool operator!= (const BasePrimitive2D &rPrimitive) const
 
virtual basegfx::B2DRange getB2DRange (const geometry::ViewInformation2D &rViewInformation) const
 The default implementation will use getDecomposition results to create the range. More...
 
virtual sal_uInt32 getPrimitive2DID () const =0
 provide unique ID for fast identifying of known primitive implementations in renderers. More...
 
virtual void get2DDecomposition (Primitive2DDecompositionVisitor &rVisitor, const geometry::ViewInformation2D &rViewInformation) const
 The default implementation will return an empty sequence. More...
 
Primitive2DContainer getDecomposition (const css::uno::Sequence< css::beans::PropertyValue > &rViewParameters)
 The getDecomposition implementation for UNO API will use getDecomposition from this implementation. More...
 
css::geometry::RealRectangle2D getRange (const css::uno::Sequence< css::beans::PropertyValue > &rViewParameters)
 The getRange implementation for UNO API will use getRange from this implementation. More...
 
virtual sal_Int64 estimateUsage ()
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Member Functions

virtual void create2DDecomposition (Primitive2DContainer &rContainer, const geometry::ViewInformation2D &rViewInformation) const override
 create local decomposition More...
 

Private Attributes

basegfx::B2DPoint maPosition
 Helpline geometry definition. More...
 
basegfx::B2DVector maDirection
 
HelplineStyle2D meStyle
 
basegfx::BColor maRGBColA
 Helpline style definition. More...
 
basegfx::BColor maRGBColB
 
double mfDiscreteDashLength
 
basegfx::B2DHomMatrix maLastObjectToViewTransformation
 the last used object to view transformtion and the last Viewport, used from getDecomposition for decide buffering More...
 
basegfx::B2DRange maLastViewport
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from drawinglayer::primitive2d::BufferedDecompositionPrimitive2D
const Primitive2DContainergetBuffered2DDecomposition () const
 access methods to maBuffered2DDecomposition. More...
 
void setBuffered2DDecomposition (Primitive2DContainer &&rNew)
 
virtual void create2DDecomposition (Primitive2DContainer &rContainer, const geometry::ViewInformation2D &rViewInformation) const =0
 method which is to be used to implement the local decomposition of a 2D primitive. More...
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

HelplinePrimitive2D class.

This primitive provides a view-dependent helpline definition. The Helpline is defined by a line equation (Point and vector) and a style. When the style is a line, dependent from Viewport the visible part of that Helpline is constructed. For Point, a cross is constructed. This primitive is highly view-dependent.

The visualisation uses the two given colors to create a dashed line with the given dash length.

Definition at line 54 of file helplineprimitive2d.hxx.

Constructor & Destructor Documentation

◆ HelplinePrimitive2D()

drawinglayer::primitive2d::HelplinePrimitive2D::HelplinePrimitive2D ( const basegfx::B2DPoint rPosition,
const basegfx::B2DVector rDirection,
HelplineStyle2D  eStyle,
const basegfx::BColor rRGBColA,
const basegfx::BColor aRGBColB,
double  fDiscreteDashLength 
)

constructor

Definition at line 123 of file helplineprimitive2d.cxx.

References maPosition.

Member Function Documentation

◆ create2DDecomposition()

void drawinglayer::primitive2d::HelplinePrimitive2D::create2DDecomposition ( Primitive2DContainer rContainer,
const geometry::ViewInformation2D rViewInformation 
) const
overrideprivatevirtual

◆ get2DDecomposition()

void drawinglayer::primitive2d::HelplinePrimitive2D::get2DDecomposition ( Primitive2DDecompositionVisitor rVisitor,
const geometry::ViewInformation2D rViewInformation 
) const
overridevirtual

◆ getDirection()

const basegfx::B2DVector & drawinglayer::primitive2d::HelplinePrimitive2D::getDirection ( ) const
inline

Definition at line 88 of file helplineprimitive2d.hxx.

Referenced by create2DDecomposition(), and operator==().

◆ getDiscreteDashLength()

double drawinglayer::primitive2d::HelplinePrimitive2D::getDiscreteDashLength ( ) const
inline

Definition at line 92 of file helplineprimitive2d.hxx.

Referenced by create2DDecomposition(), and operator==().

◆ getPosition()

const basegfx::B2DPoint & drawinglayer::primitive2d::HelplinePrimitive2D::getPosition ( ) const
inline

data read access

Definition at line 87 of file helplineprimitive2d.hxx.

References maPosition.

Referenced by create2DDecomposition(), and operator==().

◆ getPrimitive2DID()

sal_uInt32 drawinglayer::primitive2d::HelplinePrimitive2D::getPrimitive2DID ( ) const
overridevirtual

provide unique ID

Implements drawinglayer::primitive2d::BasePrimitive2D.

Definition at line 179 of file helplineprimitive2d.cxx.

References PRIMITIVE2D_ID_HELPLINEPRIMITIVE2D.

◆ getRGBColA()

const basegfx::BColor & drawinglayer::primitive2d::HelplinePrimitive2D::getRGBColA ( ) const
inline

Definition at line 90 of file helplineprimitive2d.hxx.

Referenced by create2DDecomposition(), and operator==().

◆ getRGBColB()

const basegfx::BColor & drawinglayer::primitive2d::HelplinePrimitive2D::getRGBColB ( ) const
inline

Definition at line 91 of file helplineprimitive2d.hxx.

Referenced by create2DDecomposition(), and operator==().

◆ getStyle()

HelplineStyle2D drawinglayer::primitive2d::HelplinePrimitive2D::getStyle ( ) const
inline

Definition at line 89 of file helplineprimitive2d.hxx.

Referenced by create2DDecomposition(), and operator==().

◆ operator==()

bool drawinglayer::primitive2d::HelplinePrimitive2D::operator== ( const BasePrimitive2D rPrimitive) const
overridevirtual

Member Data Documentation

◆ maDirection

basegfx::B2DVector drawinglayer::primitive2d::HelplinePrimitive2D::maDirection
private

Definition at line 59 of file helplineprimitive2d.hxx.

◆ maLastObjectToViewTransformation

basegfx::B2DHomMatrix drawinglayer::primitive2d::HelplinePrimitive2D::maLastObjectToViewTransformation
private

the last used object to view transformtion and the last Viewport, used from getDecomposition for decide buffering

Definition at line 70 of file helplineprimitive2d.hxx.

Referenced by get2DDecomposition().

◆ maLastViewport

basegfx::B2DRange drawinglayer::primitive2d::HelplinePrimitive2D::maLastViewport
private

Definition at line 71 of file helplineprimitive2d.hxx.

Referenced by get2DDecomposition().

◆ maPosition

basegfx::B2DPoint drawinglayer::primitive2d::HelplinePrimitive2D::maPosition
private

Helpline geometry definition.

Definition at line 58 of file helplineprimitive2d.hxx.

◆ maRGBColA

basegfx::BColor drawinglayer::primitive2d::HelplinePrimitive2D::maRGBColA
private

Helpline style definition.

Definition at line 63 of file helplineprimitive2d.hxx.

◆ maRGBColB

basegfx::BColor drawinglayer::primitive2d::HelplinePrimitive2D::maRGBColB
private

Definition at line 64 of file helplineprimitive2d.hxx.

◆ meStyle

HelplineStyle2D drawinglayer::primitive2d::HelplinePrimitive2D::meStyle
private

Definition at line 60 of file helplineprimitive2d.hxx.

◆ mfDiscreteDashLength

double drawinglayer::primitive2d::HelplinePrimitive2D::mfDiscreteDashLength
private

Definition at line 65 of file helplineprimitive2d.hxx.


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