From 21b68db761a6c7fa9c2e0354e139deceb028020a Mon Sep 17 00:00:00 2001 From: Thorsten Behrens Date: Fri, 11 Oct 2013 15:16:24 +0200 Subject: More detailed docs on drawinglayer primitive UNO api. Change-Id: I4e1c86be5fbfff12f32ae5471000889ee9a990b4 --- offapi/com/sun/star/graphic/XPrimitive2D.idl | 21 +++++-- .../com/sun/star/graphic/XPrimitiveFactory2D.idl | 72 ++++++++++++++++++++++ 2 files changed, 89 insertions(+), 4 deletions(-) diff --git a/offapi/com/sun/star/graphic/XPrimitive2D.idl b/offapi/com/sun/star/graphic/XPrimitive2D.idl index 30bdeaf8caf3..d6a230d722d8 100644 --- a/offapi/com/sun/star/graphic/XPrimitive2D.idl +++ b/offapi/com/sun/star/graphic/XPrimitive2D.idl @@ -39,11 +39,19 @@ interface XPrimitive2D : ::com::sun::star::uno::XInterface 2D View-specific parameter set. The defined but not mandatory parameters include: - ::com::sun::star::geometry::AffineMatrix2D Transformation + ::com::sun::star::geometry::AffineMatrix2D ObjectTransformation - A transformation matrix which maps between world coordinates (which - is equal to object's local coordinates) to view coordinates. If not - defined, an empty transformation is implied. + A transformation matrix which maps between object coordinates + (which is equal to object's local coordinates) to world + coordinates. If not defined, the identity transformation is + implied. + + ::com::sun::star::geometry::AffineMatrix2D ViewTransformation + + A transformation matrix which maps between world coordinates + to view coordinates, i.e. usually the actual pixel on + screen. If not defined, the identity transformation is + implied. ::com::sun::star::geometry::RealRectangle2D Viewport @@ -58,6 +66,11 @@ interface XPrimitive2D : ::com::sun::star::uno::XInterface lead to varied results for animated objects. This value is defined in the range [0.0 .. n[, negative values are not allowed. If not given, a value of 0.0 is implied. + + ::com::sun::star::drawing::XDrawPage VisualizedPage + + The page object this is displayed on. Used to e.g. resolve + page number placeholders and the like. */ sequence< XPrimitive2D > getDecomposition( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters ); diff --git a/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl b/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl index 6dfcc424af2f..fee1a79456d3 100644 --- a/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl +++ b/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl @@ -53,6 +53,42 @@ interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface Sequence of factory parameters, whose semantics depend on the shape to be generated. + 2D View-specific parameter set. The defined but not mandatory + parameters include: + + ::com::sun::star::geometry::AffineMatrix2D ObjectTransformation + + A transformation matrix which maps between object coordinates + (which is equal to object's local coordinates) to world + coordinates. If not defined, the identity transformation is + implied. + + ::com::sun::star::geometry::AffineMatrix2D ViewTransformation + + A transformation matrix which maps between world coordinates + to view coordinates, i.e. usually the actual pixel on + screen. If not defined, the identity transformation is + implied. + + ::com::sun::star::geometry::RealRectangle2D Viewport + + Defines the visible part of the view in world coordinates. May be used + to optimize decompositions, e.g. for 3d scenes only the visible part + needs to be created. If not given, an empty Viewport is implied which + means all is visible. + + double Time + + Defines the point in time for which the geometry is defined. This may + lead to varied results for animated objects. This value is defined in the + range [0.0 .. n[, negative values are not allowed. If not given, a value of + 0.0 is implied. + + ::com::sun::star::drawing::XDrawPage VisualizedPage + + The page object this is displayed on. Used to e.g. resolve + page number placeholders and the like. + @return a sequence of primitives, that consists of the geometrical representation from the given XShape. */ @@ -71,6 +107,42 @@ interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface Sequence of factory parameters, whose semantics depend on the page to be generated. + 2D View-specific parameter set. The defined but not mandatory + parameters include: + + ::com::sun::star::geometry::AffineMatrix2D ObjectTransformation + + A transformation matrix which maps between object coordinates + (which is equal to object's local coordinates) to world + coordinates. If not defined, the identity transformation is + implied. + + ::com::sun::star::geometry::AffineMatrix2D ViewTransformation + + A transformation matrix which maps between world coordinates + to view coordinates, i.e. usually the actual pixel on + screen. If not defined, the identity transformation is + implied. + + ::com::sun::star::geometry::RealRectangle2D Viewport + + Defines the visible part of the view in world coordinates. May be used + to optimize decompositions, e.g. for 3d scenes only the visible part + needs to be created. If not given, an empty Viewport is implied which + means all is visible. + + double Time + + Defines the point in time for which the geometry is defined. This may + lead to varied results for animated objects. This value is defined in the + range [0.0 .. n[, negative values are not allowed. If not given, a value of + 0.0 is implied. + + ::com::sun::star::drawing::XDrawPage VisualizedPage + + The page object this is displayed on. Used to e.g. resolve + page number placeholders and the like. + @return a sequence of primitives, that consists of the geometrical representation for the given XDrawPage. */ -- cgit