openshot-audio  0.1.5
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
juce::DrawableShape Class Reference

#include <juce_gui_basics.h>

Inheritance diagram for juce::DrawableShape:
juce::Drawable juce::Component juce::MouseListener juce::DrawablePath juce::DrawableRectangle

Classes

class  FillAndStrokeState
 
class  RelativeFillType
 
class  RelativePositioner
 

Public Member Functions

 ~DrawableShape ()
 
void setFill (const FillType &newFill)
 
void setFill (const RelativeFillType &newFill)
 
const RelativeFillTypegetFill () const noexcept
 
void setStrokeFill (const FillType &newStrokeFill)
 
void setStrokeFill (const RelativeFillType &newStrokeFill)
 
const RelativeFillTypegetStrokeFill () const noexcept
 
void setStrokeType (const PathStrokeType &newStrokeType)
 
void setStrokeThickness (float newThickness)
 
const PathStrokeTypegetStrokeType () const noexcept
 
Rectangle< float > getDrawableBounds () const override
 
void paint (Graphics &) override
 
bool hitTest (int x, int y) override
 
bool replaceColour (Colour originalColour, Colour replacementColour) override
 
- Public Member Functions inherited from juce::Drawable
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
 
- 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 ()
 
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 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 ()
 

Protected Member Functions

 DrawableShape ()
 
 DrawableShape (const DrawableShape &)
 
void pathChanged ()
 
void strokeChanged ()
 
bool isStrokeVisible () const noexcept
 
void refreshFillTypes (const FillAndStrokeState &newState, ComponentBuilder::ImageProvider *)
 
void writeTo (FillAndStrokeState &state, ComponentBuilder::ImageProvider *, UndoManager *) const
 
- Protected Member Functions inherited from juce::Drawable
 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

PathStrokeType strokeType
 
Path path
 
Path strokePath
 
- Protected Attributes inherited from juce::Drawable
Point< int > originRelativeToComponent
 

Additional Inherited Members

- Public Types inherited from juce::Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Static Public Member Functions inherited from juce::Drawable
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
 

Detailed Description

A base class implementing common functionality for Drawable classes which consist of some kind of filled and stroked outline.

See also
DrawablePath, DrawableRectangle

Constructor & Destructor Documentation

◆ DrawableShape() [1/2]

DrawableShape::DrawableShape ( )
protected

◆ DrawableShape() [2/2]

DrawableShape::DrawableShape ( const DrawableShape other)
protected

◆ ~DrawableShape()

DrawableShape::~DrawableShape ( )

Destructor.

Member Function Documentation

◆ getDrawableBounds()

Rectangle< float > DrawableShape::getDrawableBounds ( ) const
overridevirtual

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.

Implements juce::Drawable.

◆ getFill()

const RelativeFillType& juce::DrawableShape::getFill ( ) const
inlinenoexcept

Returns the current fill type.

See also
setFill

◆ getStrokeFill()

const RelativeFillType& juce::DrawableShape::getStrokeFill ( ) const
inlinenoexcept

Returns the current stroke fill.

See also
setStrokeFill

◆ getStrokeType()

const PathStrokeType& juce::DrawableShape::getStrokeType ( ) const
inlinenoexcept

Returns the current outline style.

◆ hitTest()

bool DrawableShape::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
xthe 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
ythe 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.

◆ isStrokeVisible()

bool DrawableShape::isStrokeVisible ( ) const
protectednoexcept

True if there's a stroke with a non-zero thickness and non-transparent colour.

◆ paint()

void DrawableShape::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
gthe graphics context that must be used to do the drawing operations.
See also
repaint, paintOverChildren, Graphics

Reimplemented from juce::Component.

◆ pathChanged()

void DrawableShape::pathChanged ( )
protected

Called when the cached path should be updated.

◆ refreshFillTypes()

void DrawableShape::refreshFillTypes ( const FillAndStrokeState newState,
ComponentBuilder::ImageProvider imageProvider 
)
protected

Updates the details from a FillAndStrokeState object, returning true if something changed.

◆ replaceColour()

bool DrawableShape::replaceColour ( Colour  originalColour,
Colour  replacementColour 
)
overridevirtual

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

Reimplemented from juce::Drawable.

◆ setFill() [1/2]

void DrawableShape::setFill ( const FillType newFill)

Sets a fill type for the path. This colour is used to fill the path - if you don't want the path to be filled (e.g. if you're just drawing an outline), set this to a transparent colour.

See also
setPath, setStrokeFill

◆ setFill() [2/2]

void DrawableShape::setFill ( const RelativeFillType newFill)

Sets a fill type for the path. This colour is used to fill the path - if you don't want the path to be filled (e.g. if you're just drawing an outline), set this to a transparent colour.

See also
setPath, setStrokeFill

◆ setStrokeFill() [1/2]

void DrawableShape::setStrokeFill ( const FillType newStrokeFill)

Sets the fill type with which the outline will be drawn.

See also
setFill

◆ setStrokeFill() [2/2]

void DrawableShape::setStrokeFill ( const RelativeFillType newStrokeFill)

Sets the fill type with which the outline will be drawn.

See also
setFill

◆ setStrokeThickness()

void DrawableShape::setStrokeThickness ( float  newThickness)

Changes the stroke thickness. This is a shortcut for calling setStrokeType.

◆ setStrokeType()

void DrawableShape::setStrokeType ( const PathStrokeType newStrokeType)

Changes the properties of the outline that will be drawn around the path. If the stroke has 0 thickness, no stroke will be drawn.

See also
setStrokeThickness, setStrokeColour

◆ strokeChanged()

void DrawableShape::strokeChanged ( )
protected

Called when the cached stroke should be updated.

◆ writeTo()

void DrawableShape::writeTo ( FillAndStrokeState state,
ComponentBuilder::ImageProvider imageProvider,
UndoManager undoManager 
) const
protected

Writes the stroke and fill details to a FillAndStrokeState object.

Member Data Documentation

◆ path

Path juce::DrawableShape::path
protected

◆ strokePath

Path juce::DrawableShape::strokePath
protected

◆ strokeType

PathStrokeType juce::DrawableShape::strokeType
protected

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