oaOrient Class Reference


Public Methods

 oaOrient (oaOrientEnum valueIn=oacR0)
 oaOrient (const oaString &name)
 ~oaOrient ()
oaOrient concat (const oaOrient &orient) const
oaOrient getRelativeOrient (const oaOrient &orient) const
const oaString & getName () const
 operator oaOrientEnum () const

Detailed Description

The oaOrient is an enum wrapper class that describes the various possible combinations of rotation and mirroring about the X or Y axes.

The Using Transforms section in the Programmers Guide has an illustration of each orientation.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaOrientEnum
 

The oaOrient enumerator. Mirror about the Y axis means mirror horizontally. Mirror about the X axis means mirror vertically.

Enumeration values:
oacR0  "R0" Represents no change in orientation
oacR90  "R90" Represents a 90 degree rotation
oacR180  "R180" Represents a 180 degree rotation
oacR270  "R270" Represents a 270 degree rotation
oacMY  "MY" Represents mirroring about the Y axis
oacMYR90  "MYR90" Represents mirroring about the Y axis then a 90 degree rotation
oacMX  "MX" Represents mirroring about the X axis
oacMXR90  "MXR90" Represents mirroring about the X axis then a 90 degree rotation

Constructor & Destructor Documentation

oaOrient::oaOrient (  oaOrientEnum    valueIn = oacR0 )  [inline]
 

This function constructs an instance of an oaOrient class using the specified enum value.

Note: "Mirror X" orientation is about the X (horizontal) axis, and "Mirror Y" is about the Y (vertical) axis.

oaOrient::oaOrient (  const oaString &    name ) 
 

This function constructs an instance of an oaOrient class using the oaOrientEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaOrientEnum.

Exceptions:
oacInvalidOrientName 

oaOrient::~oaOrient (    )  [inline]
 

This function destroys this oaOrient class.

Member Function Documentation

oaOrient oaOrient::concat (  const oaOrient &    orient )  const [inline]
 

This function concatenates this orientation with the specified orientation and returns the result.

Parameters:
orient The orientation with which to concatenate this orientation

const oaString & oaOrient::getName (    )  const
 

This function returns the name string associated with the encapsulated oaOrientEnum object.

oaOrient oaOrient::getRelativeOrient (  const oaOrient &    orient )  const
 

This function returns the relative orientation required to transform this orientation to the specified target orientation 'orient'.

Parameters:
orient The target orientation

oaOrient::operator oaOrientEnum (    )  const [inline]
 

This operator casts this oaOrient object into the corresponding oaOrientEnum value.

The documentation for this class was generated from the following files:

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.