DrawableComposite Class Reference

A drawable object which acts as a container for a set of other Drawables. More...

Inherits Drawable.

List of all members.

Classes
class	ValueTreeWrapper
	Internally-used class for wrapping a DrawableComposite's state into a ValueTree. More...
Public Member Functions
	DrawableComposite ()
	Creates a composite Drawable.
	DrawableComposite (const DrawableComposite &other)
	Creates a copy of a DrawableComposite.
	~DrawableComposite ()
	Destructor.
void	setBoundingBox (const RelativeParallelogram &newBoundingBox)
	Sets the parallelogram that defines the target position of the content rectangle when the drawable is rendered.
const RelativeParallelogram &	getBoundingBox () const noexcept
	Returns the parallelogram that defines the target position of the content rectangle when the drawable is rendered.
void	resetBoundingBoxToContentArea ()
	Changes the bounding box transform to match the content area, so that any sub-items will be drawn at their untransformed positions.
RelativeRectangle	getContentArea () const
	Returns the main content rectangle.
void	setContentArea (const RelativeRectangle &newArea)
	Changes the main content area.
void	resetContentAreaAndBoundingBoxToFitChildren ()
	Resets the content area and the bounding transform to fit around the area occupied by the child components (ignoring any markers).
Drawable *	createCopy () const
void	refreshFromValueTree (const ValueTree &tree, ComponentBuilder &builder)
ValueTree	createValueTree (ComponentBuilder::ImageProvider *imageProvider) const
Rectangle< float >	getDrawableBounds () const
void	childBoundsChanged (Component *)
void	childrenChanged ()
void	parentHierarchyChanged ()
MarkerList *	getMarkers (bool xAxis)
Static Public Attributes
static const char *const	contentLeftMarkerName
	The name of the marker that defines the left edge of the content area.
static const char *const	contentRightMarkerName
	The name of the marker that defines the right edge of the content area.
static const char *const	contentTopMarkerName
	The name of the marker that defines the top edge of the content area.
static const char *const	contentBottomMarkerName
	The name of the marker that defines the bottom edge of the content area.
static const Identifier	valueTreeType

---

Detailed Description

A drawable object which acts as a container for a set of other Drawables.

See also:

Drawable

---

Constructor & Destructor Documentation

DrawableComposite::DrawableComposite

(

)

Creates a composite Drawable.

DrawableComposite::DrawableComposite

(

const DrawableComposite &

other

)

Creates a copy of a DrawableComposite.

DrawableComposite::~DrawableComposite

(

)

Destructor.

---

Member Function Documentation

void DrawableComposite::setBoundingBox

(

const RelativeParallelogram &

newBoundingBox

)

Sets the parallelogram that defines the target position of the content rectangle when the drawable is rendered.

See also:

setContentArea

const RelativeParallelogram& DrawableComposite::getBoundingBox

(

)

const

Returns the parallelogram that defines the target position of the content rectangle when the drawable is rendered.

See also:

setBoundingBox

void DrawableComposite::resetBoundingBoxToContentArea

(

)

Changes the bounding box transform to match the content area, so that any sub-items will be drawn at their untransformed positions.

RelativeRectangle DrawableComposite::getContentArea

(

)

const

Returns the main content rectangle.

The content area is actually defined by the markers named "left", "right", "top" and "bottom", but this method is a shortcut that returns them all at once.

See also:

contentLeftMarkerName, contentRightMarkerName, contentTopMarkerName, contentBottomMarkerName

void DrawableComposite::setContentArea

(

const RelativeRectangle &

newArea

)

Changes the main content area.

The content area is actually defined by the markers named "left", "right", "top" and "bottom", but this method is a shortcut that sets them all at once.

See also:

setBoundingBox, contentLeftMarkerName, contentRightMarkerName, contentTopMarkerName, contentBottomMarkerName

void DrawableComposite::resetContentAreaAndBoundingBoxToFitChildren

(

)

Resets the content area and the bounding transform to fit around the area occupied by the child components (ignoring any markers).

Drawable* DrawableComposite::createCopy

(

)

const [virtual]

Implements Drawable.

void DrawableComposite::refreshFromValueTree	(	const ValueTree &	tree,
		ComponentBuilder &	builder
	)

ValueTree DrawableComposite::createValueTree

(

ComponentBuilder::ImageProvider *

imageProvider

)

const [virtual]

Implements Drawable.

Rectangle<float> DrawableComposite::getDrawableBounds

(

)

const [virtual]

Implements Drawable.

void DrawableComposite::childBoundsChanged

(

Component *

)

[virtual]

Reimplemented from Component.

void DrawableComposite::childrenChanged

(

)

[virtual]

Reimplemented from Component.

void DrawableComposite::parentHierarchyChanged

(

)

[virtual]

Reimplemented from Drawable.

MarkerList* DrawableComposite::getMarkers

(

bool

xAxis

)

[virtual]

Reimplemented from Component.

---

Member Data Documentation

const char* const DrawableComposite::contentLeftMarkerName [static]

The name of the marker that defines the left edge of the content area.

const char* const DrawableComposite::contentRightMarkerName [static]

The name of the marker that defines the right edge of the content area.

const char* const DrawableComposite::contentTopMarkerName [static]

The name of the marker that defines the top edge of the content area.

const char* const DrawableComposite::contentBottomMarkerName [static]

The name of the marker that defines the bottom edge of the content area.

const Identifier DrawableComposite::valueTreeType [static]

---

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

• juce_DrawableComposite.h