Struct CIVector 

pub struct CIVector { /* private fields */ }

Available on crate feature CIVector only.

The Core Image class that defines a vector object.

A CIVector can store one or more CGFloat in one object. They can store a group of float values for a variety of different uses such as coordinate points, direction vectors, geometric rectangles, transform matrices, convolution weights, or just a list a parameter values.

You use CIVector objects in conjunction with other Core Image classes, such as CIFilter-class and CIKernel. Many of the built-in Core Image filters have one or more CIVector inputs that you can set to affect the filter’s behavior.

See also Apple’s documentation

Implementations

impl CIVector

pub unsafe fn vectorWithValues_count( values: NonNull<CGFloat>, count: usize, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with the specified values.

• Parameters:
• values: The pointer CGFloat values to initialize the vector with.
• count: The number of CGFloats specified by the values parameter.
• Returns: An autoreleased CIVector object of length count.

Safety

values must be a valid pointer.

pub unsafe fn vectorWithX(x: CGFloat) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with one value.

• Parameters:
• x: The value for the first position in the vector.
• Returns: An autoreleased CIVector object of length 1.

pub unsafe fn vectorWithX_Y(x: CGFloat, y: CGFloat) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with two values.

• Parameters:
• x: The value for the first position in the vector.
• y: The value for the second position in the vector.
• Returns: An autoreleased CIVector object of length 2.

pub unsafe fn vectorWithX_Y_Z( x: CGFloat, y: CGFloat, z: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with three values.

• 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.
• Returns: An autoreleased CIVector object of length 3.

pub unsafe fn vectorWithX_Y_Z_W( x: CGFloat, y: CGFloat, z: CGFloat, w: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with four values.

• 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 forth position in the vector.
• Returns: An autoreleased CIVector object of length 4.

pub unsafe fn vectorWithCGPoint(p: CGPoint) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with two values provided by a CGPoint structure.

The CGRect structure’s y and y values are stored in the vector’s two values.

• Parameters:
• p: The CGPoint structure.
• Returns: An autoreleased CIVector object of length 2.

pub unsafe fn vectorWithCGRect(r: CGRect) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with four values provided by a CGRect structure.

The CGRect structure’s x, y, height and width values are stored in the vector’s four values.

• Parameters:
• r: The CGRect structure.
• Returns: An autoreleased CIVector object of length 4.

pub unsafe fn vectorWithCGAffineTransform( t: CGAffineTransform, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a Core Image vector object that is initialized with six values provided by a CGAffineTransform structure.

The CGAffineTransform structure’s a, b, c, d, tx and ty values are stored in the vector’s six values.

• Parameters:
• t: The CGAffineTransform structure.
• Returns: An autoreleased CIVector object of length 6.

pub unsafe fn vectorWithString(representation: &NSString) -> Retained<Self>

Create a Core Image vector object with values provided in a string representation.

• Parameters:
• representation: A string that is in one of the formats returned by the stringRepresentation method.
• Returns: An autoreleased CIVector object.

pub unsafe fn initWithValues_count( this: Allocated<Self>, values: NonNull<CGFloat>, count: usize, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with the specified the values.

• Parameters:
• values: A pointer CGFloat values for vector.
• count: The number of CGFloats specified by the values parameter.
• Returns: An initialized CIVector object of length count.

Safety

values must be a valid pointer.

pub unsafe fn initWithX(this: Allocated<Self>, x: CGFloat) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with one value.

• Parameters:
• x: The value for the first position in the vector.
• Returns: An initialized CIVector object of length 1.

pub unsafe fn initWithX_Y( this: Allocated<Self>, x: CGFloat, y: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with two values.

• Parameters:
• x: The value for the first position in the vector.
• y: The value for the second position in the vector.
• Returns: An initialized CIVector object of length 2.

pub unsafe fn initWithX_Y_Z( this: Allocated<Self>, x: CGFloat, y: CGFloat, z: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with three values.

• 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.
• Returns: An initialized CIVector object of length 3.

pub unsafe fn initWithX_Y_Z_W( this: Allocated<Self>, x: CGFloat, y: CGFloat, z: CGFloat, w: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with four values.

• 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 forth position in the vector.
• Returns: An initialized CIVector object of length 4.

pub unsafe fn initWithCGPoint( this: Allocated<Self>, p: CGPoint, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with two values provided by a CGPoint structure.

The CGRect structure’s y and y values are stored in the vector’s two values.

• Parameters:
• p: The CGPoint structure.
• Returns: An initialized CIVector object of length 2.

pub unsafe fn initWithCGRect(this: Allocated<Self>, r: CGRect) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with four values provided by a CGRect structure.

The CGRect structure’s x, y, height and width values are stored in the vector’s four values.

• Parameters:
• r: The CGRect structure.
• Returns: An initialized CIVector object of length 4.

pub unsafe fn initWithCGAffineTransform( this: Allocated<Self>, t: CGAffineTransform, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initialize a Core Image vector object with six values provided by a CGAffineTransform structure.

The CGAffineTransform structure’s a, b, c, c, tx and ty values are stored in the vector’s six values.

• Parameters:
• t: The CGAffineTransform structure.
• Returns: An initialized CIVector object of length 6.

pub unsafe fn initWithString( this: Allocated<Self>, representation: &NSString, ) -> Retained<Self>

Initialize a Core Image vector object with values provided in a string representation.

• Parameters:
• representation: A string that is in one of the formats returned by the stringRepresentation method.
• Returns: An initialized CIVector object.

pub unsafe fn valueAtIndex(&self, index: usize) -> CGFloat

Available on crate feature objc2-core-foundation only.

Returns a value from a specific position in the vector.

The numbering of elements in a vector begins with zero.

• Parameters:
• index: The position in the vector of the value that you want to retrieve.
• Returns: The value retrieved from the vector or 0 if the position is undefined.

pub unsafe fn count(&self) -> usize

The number of items in the vector.

pub unsafe fn X(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The value located in the first position in the vector.

pub unsafe fn Y(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The value located in the second position in the vector.

pub unsafe fn Z(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The value located in the third position in the vector.

pub unsafe fn W(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The value located in the forth position in the vector.

pub unsafe fn CGPointValue(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

Returns the values in the vector as a CGPoint structure.

• Returns: Reading this property returns a CGPoint structure from the X and Y values from the vector.

pub unsafe fn CGRectValue(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

Returns the values in the vector as a CGRect structure.

• Returns: Reading this property creates a CGRect structure whose origin is the X, Y, Z and W values from the vector.

pub unsafe fn CGAffineTransformValue(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

Returns the values in the vector as a CGAffineTransformValue structure.

• Returns: Reading this property creates a CGAffineTransformValue structure from the first six values in the vector.

pub unsafe fn stringRepresentation(&self) -> Retained<NSString>

Returns a formatted string with all the values of a CIVector.

Some example string representations of vectors:

CIVector	stringRepresentation
[CIVector vectorWithX:1.0 Y:0.5 Z:0.3]	"[1.0 0.5 0.3]"
[CIVector vectorWithX:10.0 Y:23.0]	"[10.0 23.0]"

To create a CIVector object from a string representation, use the vectorWithString: method.

impl CIVector

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for CIVector

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CIVector> for CIVector

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for CIVector

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for CIVector

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CIVector

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CIVector

const NAME: &'static str = "CIVector"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CIVector as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for CIVector

type Result = CIVector

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for CIVector

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CIVector

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for CIVector

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for CIVector

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for CIVector

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for CIVector

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for CIVector

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CIVector

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for CIVector

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for CIVector

impl Eq for CIVector

impl NSCoding for CIVector

impl Send for CIVector

impl Sync for CIVector