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

MediaPrimitive2D class. More...

#include <mediaprimitive2d.hxx>

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

Public Member Functions

 MediaPrimitive2D (basegfx::B2DHomMatrix aTransform, OUString aURL, const basegfx::BColor &rBackgroundColor, sal_uInt32 nDiscreteBorder, Graphic aSnapshot)
 constructor More...
 
const basegfx::B2DHomMatrixgetTransform () const
 data read access More...
 
const basegfx::BColorgetBackgroundColor () const
 
sal_uInt32 getDiscreteBorder () const
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const override
 compare operator More...
 
virtual basegfx::B2DRange getB2DRange (const geometry::ViewInformation2D &rViewInformation) const override
 get range More...
 
virtual sal_uInt32 getPrimitive2DID () const override
 provide unique ID 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
 local decomposition More...
 

Private Attributes

basegfx::B2DHomMatrix maTransform
 the geometry definition More...
 
OUString maURL
 the content definition More...
 
basegfx::BColor maBackgroundColor
 style: background color More...
 
sal_uInt32 mnDiscreteBorder
 discrete border (in 'pixels') More...
 
const Graphic maSnapshot
 

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

MediaPrimitive2D class.

This is a unified primitive for Media visualisation, e.g. animations or sounds. It's geometry is defined by Transform. For convenience, it also contains a discrete border size (aka Pixels) which will be added if used. This makes it a view-dependent primitive. It also gets a filled background and the decomposition will try to create a graphic representation if the content (defined by the URL), e.g. a still frame for animated stuff.

Definition at line 41 of file mediaprimitive2d.hxx.

Constructor & Destructor Documentation

◆ MediaPrimitive2D()

drawinglayer::primitive2d::MediaPrimitive2D::MediaPrimitive2D ( basegfx::B2DHomMatrix  aTransform,
OUString  aURL,
const basegfx::BColor rBackgroundColor,
sal_uInt32  nDiscreteBorder,
Graphic  aSnapshot 
)

constructor

Definition at line 94 of file mediaprimitive2d.cxx.

References aURL, maBackgroundColor, and maURL.

Member Function Documentation

◆ create2DDecomposition()

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

◆ getB2DRange()

basegfx::B2DRange drawinglayer::primitive2d::MediaPrimitive2D::getB2DRange ( const geometry::ViewInformation2D rViewInformation) const
overridevirtual

◆ getBackgroundColor()

const basegfx::BColor & drawinglayer::primitive2d::MediaPrimitive2D::getBackgroundColor ( ) const
inline

Definition at line 72 of file mediaprimitive2d.hxx.

References maBackgroundColor.

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

◆ getDiscreteBorder()

sal_uInt32 drawinglayer::primitive2d::MediaPrimitive2D::getDiscreteBorder ( ) const
inline

Definition at line 73 of file mediaprimitive2d.hxx.

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

◆ getPrimitive2DID()

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

provide unique ID

Implements drawinglayer::primitive2d::BasePrimitive2D.

Definition at line 142 of file mediaprimitive2d.cxx.

References PRIMITIVE2D_ID_MEDIAPRIMITIVE2D.

◆ getTransform()

const basegfx::B2DHomMatrix & drawinglayer::primitive2d::MediaPrimitive2D::getTransform ( ) const
inline

data read access

Definition at line 71 of file mediaprimitive2d.hxx.

References maTransform.

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

◆ operator==()

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

Member Data Documentation

◆ maBackgroundColor

basegfx::BColor drawinglayer::primitive2d::MediaPrimitive2D::maBackgroundColor
private

style: background color

Definition at line 51 of file mediaprimitive2d.hxx.

◆ maSnapshot

const Graphic drawinglayer::primitive2d::MediaPrimitive2D::maSnapshot
private

Definition at line 56 of file mediaprimitive2d.hxx.

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

◆ maTransform

basegfx::B2DHomMatrix drawinglayer::primitive2d::MediaPrimitive2D::maTransform
private

the geometry definition

Definition at line 45 of file mediaprimitive2d.hxx.

◆ maURL

OUString drawinglayer::primitive2d::MediaPrimitive2D::maURL
private

the content definition

Definition at line 48 of file mediaprimitive2d.hxx.

Referenced by operator==().

◆ mnDiscreteBorder

sal_uInt32 drawinglayer::primitive2d::MediaPrimitive2D::mnDiscreteBorder
private

discrete border (in 'pixels')

Definition at line 54 of file mediaprimitive2d.hxx.


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