A library for working with phylogenetic and population genetic data.
v0.27.0
Public Member Functions | Public Types | Public Attributes | List of all members
SvgImage Struct Reference

#include <genesis/utils/formats/svg/image.hpp>

Detailed Description

Definition at line 47 of file image.hpp.

Public Member Functions

 SvgImage (std::string const &href)
 
 SvgImage (std::string const &href, double x, double y, double w, double h)
 
 SvgImage (std::string const &href, SvgPoint const &position)
 
 SvgImage (std::string const &href, SvgPoint const &position, SvgSize const &size)
 
 SvgImage (SvgImage &&)=default
 
 SvgImage (SvgImage const &)=default
 
 ~SvgImage ()=default
 
SvgBox bounding_box () const
 
SvgImage & operator= (SvgImage &&)=default
 
SvgImage & operator= (SvgImage const &)=default
 
void write (std::ostream &out, size_t indent=0, SvgDrawingOptions const &options=SvgDrawingOptions()) const
 

Public Types

enum  ImageRendering {
  kNone, kAuto, kOptimizeSpeed, kOptimizeQuality,
  kSmooth, kCrispEdges, kPixelated, kInherit,
  kInitial, kUnset
}
 Rendering modes for SVG embedded images. More...
 
using self_type = SvgImage
 

Public Attributes

std::string href
 
std::string id
 
SvgPoint position
 
ImageRendering rendering = ImageRendering::kNone
 
SvgSize size
 
SvgTransform transform
 

Constructor & Destructor Documentation

◆ SvgImage() [1/6]

SvgImage ( std::string const &  href)

Definition at line 50 of file image.cpp.

◆ SvgImage() [2/6]

SvgImage ( std::string const &  href,
SvgPoint const &  position 
)

Definition at line 56 of file image.cpp.

◆ SvgImage() [3/6]

SvgImage ( std::string const &  href,
SvgPoint const &  position,
SvgSize const &  size 
)

Definition at line 64 of file image.cpp.

◆ SvgImage() [4/6]

SvgImage ( std::string const &  href,
double  x,
double  y,
double  w,
double  h 
)

Definition at line 74 of file image.cpp.

◆ ~SvgImage()

~SvgImage ( )
default

◆ SvgImage() [5/6]

SvgImage ( SvgImage const &  )
default

◆ SvgImage() [6/6]

SvgImage ( SvgImage &&  )
default

Member Function Documentation

◆ bounding_box()

SvgBox bounding_box ( ) const

Definition at line 88 of file image.cpp.

◆ operator=() [1/2]

SvgImage& operator= ( SvgImage &&  )
default

◆ operator=() [2/2]

SvgImage& operator= ( SvgImage const &  )
default

◆ write()

void write ( std::ostream &  out,
size_t  indent = 0,
SvgDrawingOptions const &  options = SvgDrawingOptions() 
) const

Definition at line 93 of file image.cpp.

Member Typedef Documentation

◆ self_type

using self_type = SvgImage

Definition at line 55 of file image.hpp.

Member Enumeration Documentation

◆ ImageRendering

enum ImageRendering
strong

Rendering modes for SVG embedded images.

Note that not all are supported by all viewers. Experimentation for the desired output format/medium/viewer/editor is needed here, unfortunately.

Enumerator
kNone 
kAuto 
kOptimizeSpeed 
kOptimizeQuality 
kSmooth 
kCrispEdges 
kPixelated 
kInherit 
kInitial 
kUnset 

Definition at line 63 of file image.hpp.

Member Data Documentation

◆ href

std::string href

Definition at line 128 of file image.hpp.

◆ id

std::string id

Definition at line 126 of file image.hpp.

◆ position

SvgPoint position

Definition at line 130 of file image.hpp.

◆ rendering

ImageRendering rendering = ImageRendering::kNone

Definition at line 134 of file image.hpp.

◆ size

SvgSize size

Definition at line 131 of file image.hpp.

◆ transform

SvgTransform transform

Definition at line 133 of file image.hpp.

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