openshot-audio  0.1.5
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
juce::Drawable Class Referenceabstract

#include <juce_gui_basics.h>

Inheritance diagram for juce::Drawable:
juce::Component juce::MouseListener juce::DrawableComposite juce::DrawableImage juce::DrawableShape juce::DrawableText juce::DrawablePath juce::DrawableRectangle

Classes

class  Positioner
 
class  ValueTreeWrapperBase
 

Public Member Functions

virtual ~Drawable ()
 
virtual DrawablecreateCopy () const =0
 
void draw (Graphics &g, float opacity, const AffineTransform &transform=AffineTransform::identity) const
 
void drawAt (Graphics &g, float x, float y, float opacity) const
 
void drawWithin (Graphics &g, const Rectangle< float > &destArea, RectanglePlacement placement, float opacity) const
 
void setOriginWithOriginalSize (Point< float > originWithinParent)
 
void setTransformToFit (const Rectangle< float > &areaInParent, RectanglePlacement placement)
 
DrawableCompositegetParent () const
 
virtual ValueTree createValueTree (ComponentBuilder::ImageProvider *imageProvider) const =0
 
virtual Rectangle< float > getDrawableBounds () const =0
 
virtual bool replaceColour (Colour originalColour, Colour replacementColour)
 
- Public Member Functions inherited from juce::Component
 Component () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () 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
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
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
 
const 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, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &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 (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
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
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (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)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () const noexcept
 
bool isParentOf (const Component *possibleChild) const noexcept
 
virtual void childrenChanged ()
 
virtual bool hitTest (int x, int y)
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 
bool contains (Point< int > localPoint)
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () 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 setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
virtual void enablementChanged ()
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
virtual MouseCursor getMouseCursor ()
 
void updateMouseCursor () const
 
virtual void paint (Graphics &g)
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseMove (const MouseEvent &event) override
 
virtual void mouseEnter (const MouseEvent &event) override
 
virtual void mouseExit (const MouseEvent &event) override
 
virtual void mouseDown (const MouseEvent &event) override
 
virtual void mouseDrag (const MouseEvent &event) override
 
virtual void mouseUp (const MouseEvent &event) override
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
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 () const
 
bool isMouseOverOrDragging () 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)
 
int runModalLoop ()
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () 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 ()
 
virtual MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from juce::MouseListener
virtual ~MouseListener ()
 

Static Public Member Functions

static DrawablecreateFromImageData (const void *data, size_t numBytes)
 
static DrawablecreateFromImageDataStream (InputStream &dataSource)
 
static DrawablecreateFromImageFile (const File &file)
 
static DrawablecreateFromSVG (const XmlElement &svgDocument)
 
static Path parseSVGPath (const String &svgPath)
 
static DrawablecreateFromValueTree (const ValueTree &tree, ComponentBuilder::ImageProvider *imageProvider)
 
static void registerDrawableTypeHandlers (ComponentBuilder &componentBuilder)
 
- Static Public Member Functions inherited from juce::Component
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

 Drawable ()
 
void transformContextToCorrectOrigin (Graphics &)
 
void parentHierarchyChanged () override
 
void setBoundsToEnclose (const Rectangle< float > &)
 
 Drawable (const Drawable &)
 
- Protected Member Functions inherited from juce::Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 

Protected Attributes

Point< int > originRelativeToComponent
 

Friends

class DrawableComposite
 
class DrawableShape
 

Additional Inherited Members

- Public Types inherited from juce::Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 

Detailed Description

The base class for objects which can draw themselves, e.g. polygons, images, etc.

See also
DrawableComposite, DrawableImage, DrawablePath, DrawableText

Constructor & Destructor Documentation

◆ Drawable() [1/2]

Drawable::Drawable ( )
protected

The base class can't be instantiated directly.

See also
DrawableComposite, DrawableImage, DrawablePath, DrawableText

◆ ~Drawable()

Drawable::~Drawable ( )
virtual

Destructor.

◆ Drawable() [2/2]

Drawable::Drawable ( const Drawable other)
protected

Member Function Documentation

◆ createCopy()

virtual Drawable* juce::Drawable::createCopy ( ) const
pure virtual

Creates a deep copy of this Drawable object.

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

Implemented in juce::DrawableComposite, juce::DrawableText, juce::DrawableImage, juce::DrawablePath, and juce::DrawableRectangle.

◆ createFromImageData()

Drawable * Drawable::createFromImageData ( const void *  data,
size_t  numBytes 
)
static

Tries to turn some kind of image file into a drawable.

The data could be an image that the ImageFileFormat class understands, or it could be SVG.

◆ createFromImageDataStream()

Drawable * Drawable::createFromImageDataStream ( InputStream dataSource)
static

Tries to turn a stream containing some kind of image data into a drawable.

The data could be an image that the ImageFileFormat class understands, or it could be SVG.

◆ createFromImageFile()

Drawable * Drawable::createFromImageFile ( const File file)
static

Tries to turn a file containing some kind of image data into a drawable.

The data could be an image that the ImageFileFormat class understands, or it could be SVG.

◆ createFromSVG()

Drawable * Drawable::createFromSVG ( const XmlElement svgDocument)
static

Attempts to parse an SVG (Scalable Vector Graphics) document, and to turn this into a Drawable tree.

The object returned must be deleted by the caller. If something goes wrong while parsing, it may return nullptr.

SVG is a pretty large and complex spec, and this doesn't aim to be a full implementation, but it can return the basic vector objects.

◆ createFromValueTree()

Drawable * Drawable::createFromValueTree ( const ValueTree tree,
ComponentBuilder::ImageProvider imageProvider 
)
static

Tries to create a Drawable from a previously-saved ValueTree. The ValueTree must have been created by the createValueTree() method. If there are any images used within the drawable, you'll need to provide a valid ImageProvider object that can be used to retrieve these images from whatever type of identifier is used to represent them. Internally, this uses a ComponentBuilder, and registerDrawableTypeHandlers().

◆ createValueTree()

virtual ValueTree juce::Drawable::createValueTree ( ComponentBuilder::ImageProvider imageProvider) const
pure virtual

Creates a ValueTree to represent this Drawable. The ValueTree that is returned can be turned back into a Drawable with createFromValueTree(). If there are any images used in this drawable, you'll need to provide a valid ImageProvider object that can be used to create storable representations of them.

Implemented in juce::DrawableComposite, juce::DrawableText, juce::DrawableImage, juce::DrawablePath, and juce::DrawableRectangle.

◆ draw()

void Drawable::draw ( Graphics g,
float  opacity,
const AffineTransform transform = AffineTransform::identity 
) const

Renders this Drawable object.

Note that the preferred way to render a drawable in future is by using it as a component and adding it to a parent, so you might want to consider that before using this method.

See also
drawWithin

◆ drawAt()

void Drawable::drawAt ( Graphics g,
float  x,
float  y,
float  opacity 
) const

Renders the Drawable at a given offset within the Graphics context.

The coordinates passed-in are used to translate the object relative to its own origin before drawing it - this is basically a quick way of saying:

Note that the preferred way to render a drawable in future is by using it as a component and adding it to a parent, so you might want to consider that before using this method.

◆ drawWithin()

void Drawable::drawWithin ( Graphics g,
const Rectangle< float > &  destArea,
RectanglePlacement  placement,
float  opacity 
) const

Renders the Drawable within a rectangle, scaling it to fit neatly inside without changing its aspect-ratio.

The object can placed arbitrarily within the rectangle based on a Justification type, and can either be made as big as possible, or just reduced to fit.

Note that the preferred way to render a drawable in future is by using it as a component and adding it to a parent, so you might want to consider that before using this method.

Parameters
gthe graphics context to render onto
destAreathe target rectangle to fit the drawable into
placementdefines the alignment and rescaling to use to fit this object within the target rectangle.
opacitythe opacity to use, in the range 0 to 1.0

◆ getDrawableBounds()

virtual Rectangle<float> juce::Drawable::getDrawableBounds ( ) const
pure virtual

Returns the area that this drawble 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.

Implemented in juce::DrawableShape, juce::DrawableComposite, juce::DrawableText, and juce::DrawableImage.

◆ getParent()

DrawableComposite * Drawable::getParent ( ) const

Returns the DrawableComposite that contains this object, if there is one.

◆ parentHierarchyChanged()

void Drawable::parentHierarchyChanged ( )
overrideprotectedvirtual

Called to indicate that the component's parents have changed.

When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).

Subclasses can override this if they need to react to this in some way.

See also
getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged

Reimplemented from juce::Component.

Reimplemented in juce::DrawableComposite.

◆ parseSVGPath()

Path Drawable::parseSVGPath ( const String svgPath)
static

Parses an SVG path string and returns it.

◆ registerDrawableTypeHandlers()

void Drawable::registerDrawableTypeHandlers ( ComponentBuilder componentBuilder)
static

Registers a set of ComponentBuilder::TypeHandler objects that can be used to load all the different Drawable types from a saved state.

See also
ComponentBuilder::registerTypeHandler()

◆ replaceColour()

bool Drawable::replaceColour ( Colour  originalColour,
Colour  replacementColour 
)
virtual

Recursively replaces a colour that might be used for filling or stroking. return true if any instances of this colour were found.

Reimplemented in juce::DrawableShape.

◆ setBoundsToEnclose()

void Drawable::setBoundsToEnclose ( const Rectangle< float > &  area)
protected

◆ setOriginWithOriginalSize()

void Drawable::setOriginWithOriginalSize ( Point< float >  originWithinParent)

Resets any transformations on this drawable, and positions its origin within its parent component.

◆ setTransformToFit()

void Drawable::setTransformToFit ( const Rectangle< float > &  areaInParent,
RectanglePlacement  placement 
)

Sets a transform for this drawable that will position it within the specified area of its parent component.

◆ transformContextToCorrectOrigin()

void Drawable::transformContextToCorrectOrigin ( Graphics g)
protected

Friends And Related Function Documentation

◆ DrawableComposite

friend class DrawableComposite
friend

◆ DrawableShape

friend class DrawableShape
friend

Member Data Documentation

◆ originRelativeToComponent

Point<int> juce::Drawable::originRelativeToComponent
protected

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