MSFScreenBounds

Objective-C


@interface MSFScreenBounds : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFScreenBounds : NSObject

A container class that defines a bounding box on the screen using minimum and maximum screen positions.

  • Checks if this object is equal to the specified object.

    Declaration

    Objective-C

    - (BOOL)isEqual:(id)object;

    Swift

    func isEqual(_ object: Any!) -> Bool

    Parameters

    object

    The reference object.

    Return Value

    True when objects are equal, false otherwise.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (NSUInteger)hash;

    Swift

    func hash() -> UInt

    Return Value

    The hash value of this object.

  • Constructs an empty ScreenBounds object. The coordinates of the minimum position will be set to positive infinity and the coordinates of the maximum position will be set to negative infinity.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Constructs a ScreenBounds object from a minimum and maximum position. If a coordinate of the minimum positon is larger than the same coordinate of the maximum position then those coordinates will be swapped.

    Declaration

    Objective-C

    - (id)initWithMin:(MSFScreenPos *)min max:(MSFScreenPos *)max;

    Swift

    init!(min: MSFScreenPos!, max: MSFScreenPos!)

    Parameters

    min

    The minimum position.
    max

    The maximum position.

  • Calculates the center screen position of this screen envelope object.

    Declaration

    Objective-C

    - (MSFScreenPos *)getCenter;

    Swift

    func getCenter() -> MSFScreenPos!

    Return Value

    The center postion if this screen envelope object.

  • Returns the width of the bounds object.

    Declaration

    Objective-C

    - (float)getWidth;

    Swift

    func getWidth() -> Float

    Return Value

    The width on the bounds object.

  • Returns the height of the bounds object.

    Declaration

    Objective-C

    - (float)getHeight;

    Swift

    func getHeight() -> Float

    Return Value

    The height on the bounds object.

  • Returns the minimum screen position.

    Declaration

    Objective-C

    - (MSFScreenPos *)getMin;

    Swift

    func getMin() -> MSFScreenPos!

    Return Value

    The minimum screen position.

  • Returns the maximum screen position of this screen envelope object.

    Declaration

    Objective-C

    - (MSFScreenPos *)getMax;

    Swift

    func getMax() -> MSFScreenPos!

    Return Value

    The maximum screen position of this screen envelope object.

  • Tests whether this screen bounds object contains a screen position.

    Declaration

    Objective-C

    - (BOOL)containsPos:(MSFScreenPos *)pos;

    Swift

    func contains(_ pos: MSFScreenPos!) -> Bool

    Parameters

    pos

    The screen position.

    Return Value

    True if this screen bounds object contains the screen position.

  • Tests whether this screen bounds object contains a another screen bounds object.

    Declaration

    Objective-C

    - (BOOL)containsBounds:(MSFScreenBounds *)bounds;

    Swift

    func contains(_ bounds: MSFScreenBounds!) -> Bool

    Parameters

    bounds

    The other screen bounds object.

    Return Value

    True if this screen bounds object contains the other screen bounds object.

  • Tests whether this screen bounds object intersects with a another screen bounds object.

    Declaration

    Objective-C

    - (BOOL)intersects:(MSFScreenBounds *)bounds;

    Swift

    func intersects(_ bounds: MSFScreenBounds!) -> Bool

    Parameters

    bounds

    The other screen bounds object.

    Return Value

    True if this screen bounds object intersects with the other screen bounds object.

  • Checks for equality between this and another screen bounds object.

    Declaration

    Objective-C

    - (BOOL)isEqualInternal:(MSFScreenBounds *)ScreenBounds;

    Swift

    func isEqualInternal(_ ScreenBounds: MSFScreenBounds!) -> Bool

    Parameters

    ScreenBounds

    The other screen bounds object.

    Return Value

    True if equal.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (int)hashInternal;

    Swift

    func hashInternal() -> Int32

    Return Value

    The hash value of this object.

  • Creates a string representation of this screen bounds object, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Swift

    func description() -> String!

    Return Value

    The string representation of this screen bounds object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()