---

QCCompositionParameterView Class Reference

Overview

The QCCompositionParameterView class allows allows users to edit, in real time, the input parameters of a composition. The composition can be rendering in any of the following objects: QCRenderer, QCView, or QCCompositionLayer.

Tasks

Getting and Setting the Renderer

• – setCompositionRenderer:
• – compositionRenderer

Checking for Input Parameters

• – hasParameters

Setting and Retrieving the Delegate

• – setDelegate:
• – delegate

Managing Background Drawing

• – setDrawsBackground:
• – drawsBackground

Setting and Getting the Background Color

• – setBackgroundColor:
• – backgroundColor

Instance Methods

backgroundColor

Retrieves the background color of the composition parameter view.

- (NSColor*) backgroundColor;

Return Value

The color of the background.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

compositionRenderer

Returns the renderer object associated with the composition parameter view.

- (id<QCCompositionRenderer>) compositionRenderer

Return Value

A renderer object or nil, if the composition parameter view is not set to a renderer object.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – setCompositionRenderer:

Declared In

QCCompositionParameterView.h

delegate

Returns the composition parameter view delegate.

- (id) delegate;

Return Value

The composition parameter view delegate.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

drawsBackground

Returns whether the composition parameter view draws its background.

- (BOOL) drawsBackground;

Return Value

YES if the view draws its background; otherwise NO.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

hasParameters

Checks whether the composition that is currently edited by the composition parameter view has any input parameters.

- (BOOL) hasParameters

Return Value

YES if the composition has any input parameters.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

setBackgroundColor:

Sets the background color of the composition parameter view.

- (void) setBackgroundColor:(NSColor*)color;

Parameters

color

The color to set.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

setCompositionRenderer:

Sets the composition parameter view for editing the input parameters of the provided renderer object.

- (void) setCompositionRenderer:(id<QCCompositionRenderer>)renderer

Parameters

renderer

A QCCompositionRenderer object, either QCView, QCRenderer, or QCCompositionLayer. Pass nil to unset this renderer.

Discussion

If the renderer is a QCView object, the view track the composition.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – compositionRenderer

Declared In

QCCompositionParameterView.h

setDelegate:

Sets the composition parameter view delegate.

- (void) setDelegate:(id)delegate;

Parameters

delegate

The delegate for the composition parameter view.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

setDrawsBackground:

Sets whether the composition parameter view draws its background.

- (void) setDrawsBackground:(BOOL)flag;

Parameters

flag

YES for the view to draw its background; otherwise NO.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

QCCompositionParameterView.h

---