LMMS
Loading...
Searching...
No Matches
juce::FillType Class Referencefinal

#include <juce_FillType.h>

Public Member Functions

 FillType () noexcept
 FillType (Colour colour) noexcept
 FillType (const ColourGradient &gradient)
 FillType (ColourGradient &&gradient)
 FillType (const Image &image, const AffineTransform &transform) noexcept
 FillType (const FillType &)
FillTypeoperator= (const FillType &)
 FillType (FillType &&) noexcept
FillTypeoperator= (FillType &&) noexcept
 ~FillType () noexcept
bool isColour () const noexcept
bool isGradient () const noexcept
bool isTiledImage () const noexcept
void setColour (Colour newColour) noexcept
void setGradient (const ColourGradient &newGradient)
void setTiledImage (const Image &image, const AffineTransform &transform) noexcept
void setOpacity (float newOpacity) noexcept
float getOpacity () const noexcept
bool isInvisible () const noexcept
FillType transformed (const AffineTransform &transform) const
bool operator== (const FillType &) const
bool operator!= (const FillType &) const

Public Attributes

Colour colour
std::unique_ptr< ColourGradientgradient
Image image
AffineTransform transform

Detailed Description

Represents a colour or fill pattern to use for rendering paths.

This is used by the Graphics and DrawablePath classes as a way to encapsulate a brush type. It can either be a solid colour, a gradient, or a tiled image.

See also
Graphics::setFillType, DrawablePath::setFill

@tags{Graphics}

Constructor & Destructor Documentation

◆ FillType() [1/7]

juce::FillType::FillType ( )
noexcept

Creates a default fill type, of solid black.

◆ FillType() [2/7]

juce::FillType::FillType ( Colour colour)
noexcept

Creates a fill type of a solid colour.

See also
setColour

◆ FillType() [3/7]

juce::FillType::FillType ( const ColourGradient & gradient)

Creates a gradient fill type.

See also
setGradient

◆ FillType() [4/7]

juce::FillType::FillType ( ColourGradient && gradient)

Creates a gradient fill type.

See also
setGradient

◆ FillType() [5/7]

juce::FillType::FillType ( const Image & image,
const AffineTransform & transform )
noexcept

Creates a tiled image fill type. The transform allows you to set the scaling, offset and rotation of the pattern.

See also
setTiledImage

◆ FillType() [6/7]

juce::FillType::FillType ( const FillType & other)

Creates a copy of another FillType.

◆ FillType() [7/7]

juce::FillType::FillType ( FillType && other)
noexcept

Move constructor

◆ ~FillType()

juce::FillType::~FillType ( )
noexcept

Destructor.

Member Function Documentation

◆ getOpacity()

float juce::FillType::getOpacity ( ) const
inlinenoexcept

Returns the current opacity to be applied to the colour, gradient, or image.

See also
setOpacity

◆ isColour()

bool juce::FillType::isColour ( ) const
inlinenoexcept

Returns true if this is a solid colour fill, and not a gradient or image.

◆ isGradient()

bool juce::FillType::isGradient ( ) const
inlinenoexcept

Returns true if this is a gradient fill.

◆ isInvisible()

bool juce::FillType::isInvisible ( ) const
noexcept

Returns true if this fill type is completely transparent.

◆ isTiledImage()

bool juce::FillType::isTiledImage ( ) const
inlinenoexcept

Returns true if this is a tiled image pattern fill.

◆ operator!=()

bool juce::FillType::operator!= ( const FillType & other) const

◆ operator=() [1/2]

FillType & juce::FillType::operator= ( const FillType & other)

Makes a copy of another FillType.

◆ operator=() [2/2]

FillType & juce::FillType::operator= ( FillType && other)
noexcept

Move assignment operator

◆ operator==()

bool juce::FillType::operator== ( const FillType & other) const

◆ setColour()

void juce::FillType::setColour ( Colour newColour)
noexcept

Turns this object into a solid colour fill. If the object was an image or gradient, those fields will no longer be valid.

◆ setGradient()

void juce::FillType::setGradient ( const ColourGradient & newGradient)

Turns this object into a gradient fill.

◆ setOpacity()

void juce::FillType::setOpacity ( float newOpacity)
noexcept

Changes the opacity that should be used. If the fill is a solid colour, this just changes the opacity of that colour. For gradients and image tiles, it changes the opacity that will be used for them.

◆ setTiledImage()

void juce::FillType::setTiledImage ( const Image & image,
const AffineTransform & transform )
noexcept

Turns this object into a tiled image fill type. The transform allows you to set the scaling, offset and rotation of the pattern.

◆ transformed()

FillType juce::FillType::transformed ( const AffineTransform & transform) const

Returns a copy of this fill, adding the specified transform applied to the existing transform.

Member Data Documentation

◆ colour

Colour juce::FillType::colour

The solid colour being used.

If the fill type is not a solid colour, the alpha channel of this colour indicates the opacity that should be used for the fill, and the RGB channels are ignored.

◆ gradient

std::unique_ptr<ColourGradient> juce::FillType::gradient

Returns the gradient that should be used for filling. This will be nullptr if the object is some other type of fill. If a gradient is active, the overall opacity with which it should be applied is indicated by the alpha channel of the colour variable.

◆ image

Image juce::FillType::image

The image that should be used for tiling. If an image fill is active, the overall opacity with which it should be applied is indicated by the alpha channel of the colour variable.

◆ transform

AffineTransform juce::FillType::transform

The transform that should be applied to the image or gradient that's being drawn.


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