juce::DrawableImage Class Reference

#include <juce_DrawableImage.h>

Inheritance diagram for juce::DrawableImage:

Public Member Functions
	DrawableImage ()
	DrawableImage (const DrawableImage &)
	DrawableImage (const Image &imageToUse)
	~DrawableImage () override
void	setImage (const Image &imageToUse)
const Image &	getImage () const noexcept
void	setOpacity (float newOpacity)
float	getOpacity () const noexcept
void	setOverlayColour (Colour newOverlayColour)
Colour	getOverlayColour () const noexcept
void	setBoundingBox (Parallelogram< float > newBounds)
void	setBoundingBox (Rectangle< float > newBounds)
Parallelogram< float >	getBoundingBox () const noexcept
void	paint (Graphics &) override
bool	hitTest (int x, int y) override
std::unique_ptr< Drawable >	createCopy () const override
Rectangle< float >	getDrawableBounds () const override
Path	getOutlineAsPath () const override
Public Member Functions inherited from juce::Drawable
	~Drawable () override
void	draw (Graphics &g, float opacity, const AffineTransform &transform=AffineTransform()) const
void	drawAt (Graphics &g, float x, float y, float opacity) const
void	drawWithin (Graphics &g, Rectangle< float > destArea, RectanglePlacement placement, float opacity) const
void	setOriginWithOriginalSize (Point< float > originWithinParent)
void	setTransformToFit (const Rectangle< float > &areaInParent, RectanglePlacement placement)
DrawableComposite *	getParent () const
void	setClipPath (std::unique_ptr< Drawable > drawableClipPath)
virtual bool	replaceColour (Colour originalColour, Colour replacementColour)
Public Member Functions inherited from juce::Component
	Component () noexcept
	~Component () override
	Component (const String &componentName) noexcept
String	getName () const noexcept
virtual void	setName (const String &newName)
String	getComponentID () const noexcept
void	setComponentID (const String &newID)
virtual void	setVisible (bool shouldBeVisible)
bool	isVisible () const noexcept
virtual void	visibilityChanged ()
bool	isShowing () const
virtual void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
void	removeFromDesktop ()
bool	isOnDesktop () const noexcept
ComponentPeer *	getPeer () const
virtual void	userTriedToCloseWindow ()
virtual void	minimisationStateChanged (bool isNowMinimised)
virtual float	getDesktopScaleFactor () const
void	toFront (bool shouldAlsoGainKeyboardFocus)
void	toBack ()
void	toBehind (Component *other)
void	setAlwaysOnTop (bool shouldStayOnTop)
bool	isAlwaysOnTop () const noexcept
int	getX () const noexcept
int	getY () const noexcept
int	getWidth () const noexcept
int	getHeight () const noexcept
int	getRight () const noexcept
Point< int >	getPosition () const noexcept
int	getBottom () const noexcept
Rectangle< int >	getBounds () const noexcept
Rectangle< int >	getLocalBounds () const noexcept
Rectangle< int >	getBoundsInParent () const noexcept
int	getScreenX () const
int	getScreenY () const
Point< int >	getScreenPosition () const
Rectangle< int >	getScreenBounds () const
Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
Rectangle< int >	getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
Rectangle< float >	getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
Point< int >	localPointToGlobal (Point< int > localPoint) const
Point< float >	localPointToGlobal (Point< float > localPoint) const
Rectangle< int >	localAreaToGlobal (Rectangle< int > localArea) const
Rectangle< float >	localAreaToGlobal (Rectangle< float > localArea) const
void	setTopLeftPosition (int x, int y)
void	setTopLeftPosition (Point< int > newTopLeftPosition)
void	setTopRightPosition (int x, int y)
void	setSize (int newWidth, int newHeight)
void	setBounds (int x, int y, int width, int height)
void	setBounds (Rectangle< int > newBounds)
void	setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
void	setBoundsRelative (Rectangle< float > proportionalArea)
void	setBoundsInset (BorderSize< int > borders)
void	setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
void	setCentrePosition (int x, int y)
void	setCentrePosition (Point< int > newCentrePosition)
void	setCentreRelative (float x, float y)
void	centreWithSize (int width, int height)
void	setTransform (const AffineTransform &transform)
AffineTransform	getTransform () const
bool	isTransformed () const noexcept
int	proportionOfWidth (float proportion) const noexcept
int	proportionOfHeight (float proportion) const noexcept
int	getParentWidth () const noexcept
int	getParentHeight () const noexcept
Rectangle< int >	getParentMonitorArea () const
int	getNumChildComponents () const noexcept
Component *	getChildComponent (int index) const noexcept
int	getIndexOfChildComponent (const Component *child) const noexcept
const Array< Component * > &	getChildren () const noexcept
Component *	findChildWithID (StringRef componentID) const noexcept
void	addChildComponent (Component *child, int zOrder=-1)
void	addChildComponent (Component &child, int zOrder=-1)
void	addAndMakeVisible (Component *child, int zOrder=-1)
void	addAndMakeVisible (Component &child, int zOrder=-1)
void	addChildAndSetID (Component *child, const String &componentID)
void	removeChildComponent (Component *childToRemove)
Component *	removeChildComponent (int childIndexToRemove)
void	removeAllChildren ()
void	deleteAllChildren ()
Component *	getParentComponent () const noexcept
template<class TargetClass>
TargetClass *	findParentComponentOfClass () const
Component *	getTopLevelComponent () const noexcept
bool	isParentOf (const Component *possibleChild) const noexcept
virtual void	childrenChanged ()
void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
bool	contains (Point< int > localPoint)
bool	contains (Point< float > localPoint)
bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
bool	reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
Component *	getComponentAt (int x, int y)
Component *	getComponentAt (Point< int > position)
Component *	getComponentAt (Point< float > position)
void	repaint ()
void	repaint (int x, int y, int width, int height)
void	repaint (Rectangle< int > area)
void	setBufferedToImage (bool shouldBeBuffered)
Image	createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
bool	isPaintingUnclipped () const noexcept
void	setComponentEffect (ImageEffectFilter *newEffect)
ImageEffectFilter *	getComponentEffect () const noexcept
LookAndFeel &	getLookAndFeel () const noexcept
void	setLookAndFeel (LookAndFeel *newLookAndFeel)
virtual void	lookAndFeelChanged ()
void	sendLookAndFeelChange ()
void	setOpaque (bool shouldBeOpaque)
bool	isOpaque () const noexcept
void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
bool	isBroughtToFrontOnMouseClick () const noexcept
void	setExplicitFocusOrder (int newFocusOrderIndex)
int	getExplicitFocusOrder () const
void	setFocusContainerType (FocusContainerType containerType) noexcept
bool	isFocusContainer () const noexcept
bool	isKeyboardFocusContainer () const noexcept
Component *	findFocusContainer () const
Component *	findKeyboardFocusContainer () const
void	setWantsKeyboardFocus (bool wantsFocus) noexcept
bool	getWantsKeyboardFocus () const noexcept
void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
bool	getMouseClickGrabsKeyboardFocus () const noexcept
void	grabKeyboardFocus ()
void	giveAwayKeyboardFocus ()
bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
void	moveKeyboardFocusToSibling (bool moveToNext)
virtual std::unique_ptr< ComponentTraverser >	createFocusTraverser ()
virtual std::unique_ptr< ComponentTraverser >	createKeyboardFocusTraverser ()
void	setHasFocusOutline (bool hasFocusOutline) noexcept
bool	hasFocusOutline () const noexcept
bool	isEnabled () const noexcept
void	setEnabled (bool shouldBeEnabled)
virtual void	enablementChanged ()
float	getAlpha () const noexcept
void	setAlpha (float newAlpha)
virtual void	alphaChanged ()
void	setMouseCursor (const MouseCursor &cursorType)
virtual MouseCursor	getMouseCursor ()
void	updateMouseCursor () const
virtual void	paintOverChildren (Graphics &g)
void	mouseMove (const MouseEvent &event) override
void	mouseEnter (const MouseEvent &event) override
void	mouseExit (const MouseEvent &event) override
void	mouseDown (const MouseEvent &event) override
void	mouseDrag (const MouseEvent &event) override
void	mouseUp (const MouseEvent &event) override
void	mouseDoubleClick (const MouseEvent &event) override
void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
void	mouseMagnify (const MouseEvent &event, float scaleFactor) override
void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
void	removeMouseListener (MouseListener *listenerToRemove)
void	addKeyListener (KeyListener *newListener)
void	removeKeyListener (KeyListener *listenerToRemove)
virtual bool	keyPressed (const KeyPress &key)
virtual bool	keyStateChanged (bool isKeyDown)
virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
virtual void	focusGained (FocusChangeType cause)
virtual void	focusLost (FocusChangeType cause)
virtual void	focusOfChildComponentChanged (FocusChangeType cause)
bool	isMouseOver (bool includeChildren=false) const
bool	isMouseButtonDown (bool includeChildren=false) const
bool	isMouseOverOrDragging (bool includeChildren=false) const
Point< int >	getMouseXYRelative () const
virtual void	resized ()
virtual void	moved ()
virtual void	childBoundsChanged (Component *child)
virtual void	parentSizeChanged ()
virtual void	broughtToFront ()
void	addComponentListener (ComponentListener *newListener)
void	removeComponentListener (ComponentListener *listenerToRemove)
void	postCommandMessage (int commandId)
virtual void	handleCommandMessage (int commandId)
void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
void	exitModalState (int returnValue)
bool	isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
bool	isCurrentlyBlockedByAnotherModalComponent () const
virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)
virtual void	inputAttemptWhenModal ()
NamedValueSet &	getProperties () noexcept
const NamedValueSet &	getProperties () const noexcept
Colour	findColour (int colourID, bool inheritFromParent=false) const
void	setColour (int colourID, Colour newColour)
void	removeColour (int colourID)
bool	isColourSpecified (int colourID) const
void	copyAllExplicitColoursTo (Component &target) const
virtual void	colourChanged ()
void *	getWindowHandle () const
Positioner *	getPositioner () const noexcept
void	setPositioner (Positioner *newPositioner)
void	setCachedComponentImage (CachedComponentImage *newCachedImage)
CachedComponentImage *	getCachedComponentImage () const noexcept
void	setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
bool	getViewportIgnoreDragFlag () const noexcept
String	getTitle () const noexcept
void	setTitle (const String &newTitle)
String	getDescription () const noexcept
void	setDescription (const String &newDescription)
String	getHelpText () const noexcept
void	setHelpText (const String &newHelpText)
void	setAccessible (bool shouldBeAccessible)
bool	isAccessible () const noexcept
AccessibilityHandler *	getAccessibilityHandler ()
void	invalidateAccessibilityHandler ()
void	setFocusContainer (bool shouldBeFocusContainer) noexcept
void	contains (int, int)=delete
Public Member Functions inherited from juce::MouseListener
virtual	~MouseListener ()=default

Private Member Functions
std::unique_ptr< AccessibilityHandler >	createAccessibilityHandler () override
bool	setImageInternal (const Image &)
DrawableImage &	operator= (const DrawableImage &)

Private Attributes
Image	image
float	opacity = 1.0f
Colour	overlayColour { 0 }
Parallelogram< float >	bounds

Additional Inherited Members
Public Types inherited from juce::Component
enum class	FocusContainerType { none , focusContainer , keyboardFocusContainer }
enum	FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
Static Public Member Functions inherited from juce::Drawable
static std::unique_ptr< Drawable >	createFromImageData (const void *data, size_t numBytes)
static std::unique_ptr< Drawable >	createFromImageDataStream (InputStream &dataSource)
static std::unique_ptr< Drawable >	createFromImageFile (const File &file)
static std::unique_ptr< Drawable >	createFromSVG (const XmlElement &svgDocument)
static std::unique_ptr< Drawable >	createFromSVGFile (const File &svgFile)
static Path	parseSVGPath (const String &svgPath)
Static Public Member Functions inherited from juce::Component
static float JUCE_CALLTYPE	getApproximateScaleFactorForComponent (const Component *targetComponent)
static Component *JUCE_CALLTYPE	getCurrentlyFocusedComponent () noexcept
static void JUCE_CALLTYPE	unfocusAllComponents ()
static void JUCE_CALLTYPE	beginDragAutoRepeat (int millisecondsBetweenCallbacks)
static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept
static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept
static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept
Protected Member Functions inherited from juce::Drawable
	Drawable ()
void	transformContextToCorrectOrigin (Graphics &)
void	parentHierarchyChanged () override
void	setBoundsToEnclose (Rectangle< float >)
void	applyDrawableClipPath (Graphics &)
void	nonConstDraw (Graphics &, float opacity, const AffineTransform &)
	Drawable (const Drawable &)
Drawable &	operator= (const Drawable &)
Protected Member Functions inherited from juce::Component
virtual ComponentPeer *	createNewPeer (int styleFlags, void *nativeWindowToAttachTo)
Static Protected Member Functions inherited from juce::Component
static std::unique_ptr< AccessibilityHandler >	createIgnoredAccessibilityHandler (Component &)
Protected Attributes inherited from juce::Drawable
Point< int >	originRelativeToComponent
std::unique_ptr< Drawable >	drawableClipPath

Detailed Description

A drawable object which is a bitmap image.

See also

Drawable

@tags{GUI}

Constructor & Destructor Documentation

DrawableImage() [1/3]

juce::DrawableImage::DrawableImage

(

)

DrawableImage() [2/3]

juce::DrawableImage::DrawableImage

(

const DrawableImage &

other

)

DrawableImage() [3/3]

juce::DrawableImage::DrawableImage ( const Image & imageToUse )

explicit

Sets the image that this drawable will render.

~DrawableImage()

juce::DrawableImage::~DrawableImage ( )

override

Destructor.

Member Function Documentation

createAccessibilityHandler()

std::unique_ptr< AccessibilityHandler > juce::DrawableImage::createAccessibilityHandler ( )

overrideprivatevirtual

Override this method to return a custom AccessibilityHandler for this component.

The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.

The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.

See also

getAccessibilityHandler

Reimplemented from juce::Component.

createCopy()

std::unique_ptr< Drawable > juce::DrawableImage::createCopy ( ) const

overridevirtual

Creates a deep copy of this Drawable object.

Use this to create a new copy of this and any sub-objects in the tree.

Implements juce::Drawable.

getBoundingBox()

Parallelogram< float > juce::DrawableImage::getBoundingBox ( ) const

inlinenoexcept

Returns the position to which the image's top-left corner should be remapped in the target coordinate space when rendering this object.

See also

setTransform

getDrawableBounds()

Rectangle< float > juce::DrawableImage::getDrawableBounds ( ) const

overridevirtual

Returns the area that this drawable covers. The result is expressed in this drawable's own coordinate space, and does not take into account any transforms that may be applied to the component.

Implements juce::Drawable.

getImage()

const Image & juce::DrawableImage::getImage ( ) const

inlinenoexcept

Returns the current image.

getOpacity()

float juce::DrawableImage::getOpacity ( ) const

inlinenoexcept

Returns the image's opacity.

getOutlineAsPath()

Path juce::DrawableImage::getOutlineAsPath ( ) const

overridevirtual

Creates a path that describes the outline of this drawable.

Implements juce::Drawable.

getOverlayColour()

Colour juce::DrawableImage::getOverlayColour ( ) const

inlinenoexcept

Returns the overlay colour.

hitTest()

bool juce::DrawableImage::hitTest ( int x, int y )

overridevirtual

Tests whether a given point is inside the component.

Overriding this method allows you to create components which only intercept mouse-clicks within a user-defined area.

This is called to find out whether a particular x, y coordinate is considered to be inside the component or not, and is used by methods such as contains() and getComponentAt() to work out which component the mouse is clicked on.

Components with custom shapes will probably want to override it to perform some more complex hit-testing.

The default implementation of this method returns either true or false, depending on the value that was set by calling setInterceptsMouseClicks() (true is the default return value).

Note that the hit-test region is not related to the opacity with which areas of a component are painted.

Applications should never call hitTest() directly - instead use the contains() method, because this will also test for occlusion by the component's parent.

Note that for components on the desktop, this method will be ignored, because it's not always possible to implement this behaviour on all platforms.

Parameters

x	the x coordinate to test, relative to the left hand edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's width
y	the y coordinate to test, relative to the top edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's height

Returns

true if the click is considered to be inside the component

See also

setInterceptsMouseClicks, contains

Reimplemented from juce::Component.

operator=()

DrawableImage & juce::DrawableImage::operator= ( const DrawableImage & )

private

paint()

void juce::DrawableImage::paint ( Graphics & g )

overridevirtual

Components can override this method to draw their content.

The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.

Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.

If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.

You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().

Parameters

g	the graphics context that must be used to do the drawing operations.

See also

repaint, paintOverChildren, Graphics

Reimplemented from juce::Component.

setBoundingBox() [1/2]

void juce::DrawableImage::setBoundingBox

(

Parallelogram< float >

newBounds

)

Sets the bounding box within which the image should be displayed.

setBoundingBox() [2/2]

void juce::DrawableImage::setBoundingBox

(

Rectangle< float >

newBounds

)

Sets the bounding box within which the image should be displayed.

setImage()

void juce::DrawableImage::setImage

(

const Image &

imageToUse

)

Sets the image that this drawable will render.

setImageInternal()

bool juce::DrawableImage::setImageInternal ( const Image & imageToUse )

private

setOpacity()

void juce::DrawableImage::setOpacity

(

float

newOpacity

)

Sets the opacity to use when drawing the image.

setOverlayColour()

void juce::DrawableImage::setOverlayColour

(

Colour

newOverlayColour

)

Sets a colour to draw over the image's alpha channel.

By default this is transparent so isn't drawn, but if you set a non-transparent colour here, then it will be overlaid on the image, using the image's alpha channel as a mask.

This is handy for doing things like darkening or lightening an image by overlaying it with semi-transparent black or white.

Member Data Documentation

bounds

Parallelogram<float> juce::DrawableImage::bounds

private

image

Image juce::DrawableImage::image

private

opacity

float juce::DrawableImage::opacity = 1.0f

private

overlayColour

Colour juce::DrawableImage::overlayColour { 0 }

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/drawables/juce_DrawableImage.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/drawables/juce_DrawableImage.cpp