CIVector Class Reference

Inherits from
Conforms to
Framework
Library/Frameworks/CoreImage.framework
Availability
Available in iOS 5.0 and later.
Companion guide
Declared in
CIVector.h

Overview

The CIVector class is used for coordinate values and direction vectors. You typically use a CIVector object to pass parameter values to Core Image filters. CIVector objects work in conjunction with other Core Image classes, such as CIFilter, CIContext, CIImage, and CIColor, to process images using the Core Image framework.

Tasks

Creating a Vector

Initializing a Vector

Getting Values From a Vector

Class Methods

vectorWithCGAffineTransform:

Creates and returns a vector that is initialized with values provided by a CGAffineTransform structure.

+ (CIVector *)vectorWithCGAffineTransform:(CGAffineTransform)t
Parameters
t

A transform.

Return Value

A vector initialized with the specified values.

Discussion

The six values that comprise the affine transform fill the first six positions of the resulting CIVector object.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithCGPoint:

Creates and returns a vector that is initialized with values provided by a CGPoint structure.

+ (CIVector *)vectorWithCGPoint:(CGPoint)p
Parameters
p

A point.

Return Value

A vector initialized with the specified values.

Discussion

The CGPoint structure’s X and Y values are stored in the vector’s X and Y properties.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithCGRect:

Creates and returns a vector that is initialized with values provided by a CGRect structure.

+ (CIVector *)vectorWithCGRect:(CGRect)r
Parameters
r

A rect.

Return Value

A vector initialized with the specified values.

Discussion

The CGRect structure’s X, Y, height and width values are stored in the vector’s X, Y, Z and W properties.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithString:

Creates and returns a vector that is initialized with values provided in a string representation.

+ (CIVector *)vectorWithString:(NSString *)representation
Parameters
representation

A string that is in one of the formats returned by the stringRepresentation method.

Discussion

Some typical string representations for vectors are:

@"[1.0 0.5 0.3]"

which specifies a vec3 vector whose components are X = 1.0, Y = 0.5, and Z = 0.3

@"[10.0 23.0]

which specifies a vec2 vector show components are X = 10.0 and Y = 23.0

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithValues:count:

Creates and returns a vector that is initialized with the specified values.

+ (CIVector *)vectorWithValues:(const CGFloat *)values count:(size_t)count
Parameters
values

The values to initialize the vector with.

count

The number of values in the vector.

Return Value

A vector initialized with the provided values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithX:

Creates and returns a vector that is initialized with one value.

+ (CIVector *)vectorWithX:(CGFloat)x
Parameters
x

The value to initialize the vector with.

Return Value

A vector initialized with the specified value.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithX:Y:

Creates and returns a vector that is initialized with two values.

+ (CIVector *)vectorWithX:(CGFloat)x Y:(CGFloat)y
Parameters
x

The value for the first position in the vector.

y

The value for the second position in the vector.

Return Value

A vector initialized with the specified values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithX:Y:Z:

Creates and returns a vector that is initialized with three values.

+ (CIVector *)vectorWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z
Parameters
x

The value for the first position in the vector.

y

The value for the second position in the vector.

z

The value for the third position in the vector.

Return Value

A vector initialized with the specified values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

vectorWithX:Y:Z:W:

Creates and returns a vector that is initialized with four values.

+ (CIVector *)vectorWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z W:(CGFloat)w
Parameters
x

The value for the first position in the vector.

y

The value for the second position in the vector.

z

The value for the third position in the vector.

w

The value for the fourth position in the vector.

Return Value

A vector initialized with the specified values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

Instance Methods

CGAffineTransformValue

Returns the values stored in the CIVector object as an affine transform.

- (CGAffineTransform)CGAffineTransformValue
Return Value

A transform.

Discussion

The first six values in the vector become the values that comprise the affine transform.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

CGPointValue

Returns the values stored in the CIVector object as a point.

- (CGPoint)CGPointValue
Return Value

A point.

Discussion

The vector’s X and Y property values become the CGPoint structure’s X and Y values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

CGRectValue

Returns the values stored in the CIVector object as an rect.

- (CGRect)CGRectValue
Return Value

A rect.

Discussion

The vector’s X, Y, Z and W property values become the CGRect structure’s X, Y, height and width values.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

count

Returns the number of items in a vector.

- (size_t)count
Return Value

The number of items in the vector.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithCGAffineTransform:

Initializes a vector that is initialized with values provided by a CGAffineTransform structure.

- (id)initWithCGAffineTransform:(CGAffineTransform)r
Parameters
r

A transform.

Discussion

The six values that comprise the affine transform fill the first six positions of the resulting CIVector object.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithCGPoint:

Initializes a vector that is initialized with values provided by a CGPoint structure.

- (id)initWithCGPoint:(CGPoint)p
Parameters
p

A point.

Discussion

The CGPoint structure’s X and Y values are stored in the vector’s X and Y properties.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithCGRect:

Initializes a vector that is initialized with values provided by a CGRect structure.

- (id)initWithCGRect:(CGRect)r
Parameters
r

A rect.

Discussion

The CGRect structure’s X, Y, height and width values are stored in the vector’s X, Y, Z and W properties.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithString:

Initializes a vector with values provided in a string representation.

- (id)initWithString:(NSString *)representation
Parameters
representation

A string that is in one of the formats returned by the stringRepresentation method.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithValues:count:

Initializes a vector with the provided values.

- (id)initWithValues:(const CGFloat *)values count:(size_t)count
Parameters
values

The values to initialize the vector with.

count

The number of values specified by the values argument.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithX:

Initializes the first position of a vector with the provided values.

- (id)initWithX:(CGFloat)x
Parameters
x

The initialization value.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithX:Y:

Initializes the first two positions of a vector with the provided values.

- (id)initWithX:(CGFloat)x Y:(CGFloat)y
Parameters
x

The initialization value for the first position.

y

The initialization value for the second position.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithX:Y:Z:

Initializes the first three positions of a vector with the provided values.

- (id)initWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z
Parameters
x

The initialization value for the first position.

y

The initialization value for the second position.

z

The initialization value for the third position.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

initWithX:Y:Z:W:

Initializes four positions of a vector with the provided values.

- (id)initWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z W:(CGFloat)w
Parameters
x

The initialization value for the first position.

y

The initialization value for the second position.

z

The initialization value for the third position.

w

The initialization value for the fourth position.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

stringRepresentation

Returns a string representation for a vector.

- (NSString *)stringRepresentation
Return Value

A string object.

Discussion

You convert the string representation returned by this method to a vector by supplying it as a parameter to the vectorWithString: method.

Some typical string representations for vectors are:

@"[1.0 0.5 0.3]"

which specifies a vec3 vector whose components are X = 1.0, Y = 0.5, and Z = 0.3

@"[10.0 23.0]

which specifies a vec2 vector show components are X = 10.0 and Y = 23.0

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

valueAtIndex:

Returns a value from a specific position in a vector.

- (CGFloat)valueAtIndex:(size_t)index
Parameters
index

The position in the vector of the value that you want to retrieve.

Return Value

The value retrieved from the vector or 0 if the position is undefined.

Discussion

The numbering of elements in a vector begins with zero.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

W

Returns the value located in the fourth position in a vector.

- (CGFloat)W
Return Value

The value retrieved from the vector.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

X

Returns the value located in the first position in a vector.

- (CGFloat)X
Return Value

The value retrieved from the vector.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

Y

Returns the value located in the second position in a vector.

- (CGFloat)Y
Return Value

The value retrieved from the vector.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h

Z

Returns the value located in the third position in a vector.

- (CGFloat)Z
Return Value

The value retrieved from the vector.

Availability
  • Available in iOS 5.0 and later.
Declared In
CIVector.h