com.google.appengine.api.images.Composite Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.appengine.api.images;

import java.util.Map;

/**
 * A {@code Composite} represents a composition of an image onto a canvas.
 *
 */
public abstract class Composite {

  /**
   * Valid anchoring positions for a compositing operation. The anchor
   * position of the image is aligned with the anchor position of the
   * canvas.
   */
  public static enum Anchor {TOP_LEFT, TOP_CENTER, TOP_RIGHT, CENTER_LEFT,
    CENTER_CENTER, CENTER_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT}

  /**
   * Adds this compositing operation to a Composite request.
   * @param request Request for this composite to be added to.
   * @param imageIndexMap Map of images and their indexes in the request.
   */
  abstract void apply(ImagesServicePb.ImagesCompositeRequest.Builder request,
             Map imageIndexMap);

}