SCIVector3 Class Reference

Gets the X component of the vector.

Declaration

Objective-C

@property (nonatomic, readonly) float x;

Gets the Y component of the vector.

Declaration

Objective-C

@property (nonatomic, readonly) float y;

Gets the Z component of the vector.

Declaration

Objective-C

@property (nonatomic, readonly) float z;


                        
                        
                        length

Gets the magnitude of the vector.

Declaration

Objective-C

@property (nonatomic, readonly) float length;


                        
                        
                        -initWithX:y:z:

Creates a vector whose elements have the specified values.

Declaration

Objective-C

- (nonnull instancetype)initWithX:(float)x y:(float)y z:(float)z;

Parameters

`x`	The `X component` of the vector.
`y`	The `X component` of the vector.
`z`	The `X component` of the vector.


                        
                        
                        -initWithVector:

Creates a new SCIVector3 object from the another SCIVector3 object.

Declaration

Objective-C

- (nonnull instancetype)initWithVector:(nonnull SCIVector3 *)vector;

Parameters


                                    vector

The specified SCIVector3 to create vector from.


                        
                        
                        -assignX:y:z:

Assign new values to the the x, y and z components.

Declaration

Objective-C

- (void)assignX:(float)x y:(float)y z:(float)z;

Parameters

`x`	The `X component` of the vector.
`y`	The `X component` of the vector.
`z`	The `X component` of the vector.


                        
                        
                        -addVector:toVector:

Adds two vectors together and stores in current instance.

Declaration

Objective-C

- (void)addVector:(nonnull SCIVector3 *)vec1
         toVector:(nonnull SCIVector3 *)vec2;

Parameters

`vec1`	The first vector.
`vec2`	The second vector.


                        
                        
                        -addWeighted:weight:

Add another vector with weighted x, y and z components.

Declaration

Objective-C

- (void)addWeighted:(nonnull SCIVector3 *)vector weight:(float)weight;

Parameters

`vector`	The vector to add.
`weight`	The weight to be applied onto `vector` components.


                        
                        
                        -substractFrom:vector:

Subtracts the vec2 from vec1 and stores the result in current instance.

Declaration

Objective-C

- (void)substractFrom:(nonnull SCIVector3 *)vec1
               vector:(nonnull SCIVector3 *)vec2;

Parameters

`vec1`	The first vector.
`vec2`	The second vector.


                        
                        
                        -multiplyBy:

Multiplies a vector by a specified scalar.

Declaration

Objective-C

- (void)multiplyBy:(float)scalar;

Parameters


                                    scalar

The scalar value.


                        
                        
                        -normalize

Makes the current vector a normal vector.

Declaration

Objective-C

- (void)normalize;


                        
                        
                        -cross:with:

Computes the cross product of two vectors ans stores it.

Declaration

Objective-C

- (void)cross:(nonnull SCIVector3 *)vec1 with:(nonnull SCIVector3 *)vec2;

Parameters

`vec1`	The first vector.
`vec2`	The second vector.


                        
                        
                        -dot:

Computes the dot product of self and passed in vector.

Declaration

Objective-C

- (float)dot:(nonnull SCIVector3 *)vec;

Parameters

vec

The vector.

Return Value

The dot product.