>  Docs Center  >  Libraries  >  Motley  >  MGH_NEW_BUFFER

MGH_NEW_BUFFER

MGH_NEW_BUFFER

Name


  MGH_NEW_BUFFER

Purpose


  This function creates and returns a new IDLgrBuffer, or similar
  destination object. It checks to see whether the buffer dimensions
  (in device units) are going to exceed the screen dimensions and if
  necessary adjusts the value of DIMENSIONS or RESOLUTION
  accordingly to keep it in bounds.

Category


  Object graphics

Calling Sequence


  Result = MGH_NEW_BUFFER(Class, DIMENSIONS=dimensions, $
                          RESOLUTION=resolution, UNITS=units)

Positional Parameters


  class (input, string scalar, optional)
    The object class name (default 'IDLgrBuffer').

Keyword Parameters


  DIMENSIONS (input, numeric 2-element vector)
    The requested dimensions of the new buffer. The actual
    dimensions may differ from this to keep the buffer size (in
    device units) within the limits set by the screen dimensions.
  MULTIPLE (input, 1 or 2-element integer)
    Buffer dimensions in pixels are forced to be an integer
    multiple of this value.
  RESOLUTION (input, numeric two-element vector or scalar)
    The requested resolution of the new buffer. The actual
    resolution may differ from this to keep the buffer size (in
    device units) within the limits set by the screen
    dimensions.
  UNITS (input, integer scalar)
    Units for the DIMENSIONS.

Return Value


  The function returns an object reference.
###########################################################################
  This software is provided subject to the following conditions:
  1. NIWA makes no representations or warranties regarding the
    accuracy of the software, the use to which the software may
    be put or the results to be obtained from the use of the
    software. Accordingly NIWA accepts no liability for any loss
    or damage (whether direct of indirect) incurred by any person
    through the use of or reliance on the software.
  2. NIWA is to be acknowledged as the original author of the
    software where the software is used or presented in any form.
###########################################################################

Modification History


  Mark Hadfield, 1998-09:
      Written.
  Mark Hadfield, 2004-05:
      Added MULTIPLE keyword.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us