region.h

Clase wxRegion

Una wxRegion representa una región simple o compleja en un contexto de dispositivo o ventana.

Jerarquía:

Esta clase utiliza internamente el recuento de referencias y la copia en escritura para que las asignaciones entre dos instancias de esta clase sean muy baratas. Por lo tanto, puede utilizar objetos reales en lugar de punteros sin problemas de eficiencia. Si se cambia una instancia de esta clase, creará sus propios datos internamente de modo que otras instancias, que previamente compartieron los datos utilizando el conteo de referencias, no se vean afectadas.

Funciones miembro

wxRegion()

wxRegion::wxRegion()

Constructor por defecto.

Este constructor crea un objeto inválido, o nulo, es decir, al llamar a IsOk() sobre él devuelve false e IsEmpty() devuelve true.

wxRegion()

wxRegion::wxRegion( wxCoord x, wxCoord y, wxCoord width, wxCoord height )

Construye una región rectangular con la posición y el tamaño dados.

wxRegion()

wxRegion::wxRegion( const wxPoint & topLeft, const wxPoint & bottomRight )

Construye una región rectangular a partir del punto superior izquierdo y el punto inferior derecho.

wxRegion()

wxRegion::wxRegion(const wxRect & rect)

Construye una región rectangular un objeto wxRect.

wxRegion()

wxRegion::wxRegion(const wxRegion & region)

Constructor de copia, utiliza contador de referencias.

wxRegion()

wxRegion::wxRegion( size_t n, const wxPoint * points, wxPolygonFillMode fillStyle = wxODDEVEN_RULE )

Construye una región correspondiente al polígono formado por n puntos de la matriz proporcionada.

El parámetro fillStyle puede tener los valores wxWINDING_RULE o wxODDEVEN_RULE.

wxRegion()

wxRegion::wxRegion(const wxBitmap & bmp)

Construye una región utilizando un mapa de bits.

Ver Union() para más detalles.

wxRegion()

wxRegion::wxRegion( const wxBitmap & bmp, const wxColour & transColour, int tolerance = 0 )

Construye una región utilizando los píxeles no transparentes de un mapa de bits.

Ver Union() para más detalles.

~wxRegion()

virtual wxRegion::~wxRegion()

Destructor.

Ver destrucción de objetos por referencia para más información.

Clear()

virtual void wxRegion::Clear()

Borra la región actual.

El objeto se vuelve inválido, o nulo, después de ser borrado.

Contains()

wxRegionContain wxRegion::Contains(const wxPoint & pt) const

Devuelve un valor que indica si el punto dado está contenido en la región.

Este método siempre devuelve wxOutRegion para una región no válida, pero puede, sin embargo, ser llamado con seguridad en este caso.

Valor de retorno

El valor devuelto es uno de wxOutRegion y wxInRegion.

Contains()

wxRegionContain wxRegion::Contains(const wxRect & rect) const

Contains()

wxRegionContain wxRegion::Contains( wxCoord x, wxCoord y ) const

Devuelve un valor que indica si el punto dado está contenido en la región.

Este método siempre devuelve wxOutRegion para una región no válida, pero puede, sin embargo, ser llamado con seguridad en este caso.

Valor de retorno

El valor devuelto es uno de wxOutRegion y wxInRegion.

Contains()

wxRegionContain wxRegion::Contains( wxCoord x, wxCoord y, wxCoord width, wxCoord height ) const

Devuelve un valor que indica si el rectángulo dado está contenido dentro de la región.

Este método siempre devuelve wxOutRegion para una región no válida, pero puede, sin embargo, ser llamado con seguridad en este caso.

Valor de retorno

Uno de wxOutRegion, wxPartRegion o wxInRegion.

Nota: En Windows, sólo se devuelven wxOutRegion y wxInRegion; un valor wxInRegion indica entonces que toda o parte de la región está contenida en esta región.

ConvertToBitmap()

wxBitmap wxRegion::ConvertToBitmap() const

Convierte la región en un mapa de bits en blanco y negro con los píxeles blancos dentro de la región.

Este método no se puede utilizar para una región no válida.

GetBox()

wxRect wxRegion::GetBox() const

Devuelve los límites exteriores de la región.

Este método devuelve un cuadro delimitador de tamaño 0 para las regiones no válidas.

GetBox()

void wxRegion::GetBox( wxCoord & x, wxCoord & y, wxCoord & width, wxCoord & height ) const

Devuelve los límites exteriores de la región.

Este método devuelve un cuadro delimitador de tamaño 0 para las regiones no válidas.

Intersect()

bool wxRegion::Intersect(const wxRect & rect)

Busca la intersección de esta región y otra región rectangular.

Este método siempre falla, es decir, devuelve false, si esta región no es válida, pero puede utilizarse con seguridad incluso en este caso.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Crea la intersección de las dos regiones, es decir, las partes que se encuentran en ambas regiones. El resultado se almacena en esta región.

Intersect()

bool wxRegion::Intersect(const wxRegion & region)

Busca la intersección de esta región y otra región.

Este método siempre falla, es decir, devuelve false, si esta región no es válida, pero puede utilizarse con seguridad incluso en este caso.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Crea la intersección de las dos regiones, es decir, las partes que se encuentran en ambas regiones. El resultado se almacena en esta región.

Intersect()

bool wxRegion::Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height )

Busca la intersección de esta región y otra región.

Este método siempre falla, es decir, devuelve false, si esta región no es válida, pero puede utilizarse con seguridad incluso en este caso.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Crea la intersección de las dos regiones, es decir, las partes que se encuentran en ambas regiones. El resultado se almacena en esta región.

IsEmpty()

virtual bool wxRegion::IsEmpty() const

Devuelve true si la región está vacía, false en caso contrario.

Siempre devuelve true si la región no es válida.

IsEqual()

bool wxRegion::IsEqual(const wxRegion & region) const

Devuelve verdadero si la región es igual, es decir, cubre la misma área que otra.

Si tanto esta región como la otra no son válidas, se consideran iguales.

Offset()

bool wxRegion::Offset(const wxPoint & pt)

Desplaza la región en las direcciones horizontal y vertical especificadas.

Este método no puede invocarse si la región no es válida, ya que entonces no tiene sentido desplazarla. Si se intenta hacerlo, se producirá un error.

Valor de retorno

true si tiene éxito, false en caso contrario (la región no cambia).

Offset()

bool wxRegion::Offset( wxCoord x, wxCoord y )

Desplaza la región en las direcciones horizontal y vertical especificadas.

Este método no puede invocarse si la región no es válida, ya que entonces no tiene sentido desplazarla. Si se intenta hacerlo, se producirá un error.

Valor de retorno

true si tiene éxito, false en caso contrario (la región no cambia).

Subtract()

bool wxRegion::Subtract(const wxRect & rect)

Resta una región rectangular de esta región.

Este método siempre falla, es decir, devuelve false, si esta región no es válida, pero puede utilizarse con seguridad incluso en este caso.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Esta operación combina las partes de «esta» región que no forman parte de la segunda región. El resultado se almacena en esta región.

Subtract()

bool wxRegion::Subtract(const wxRegion & region)

Resta una región de esta región.

Este método siempre falla, es decir, devuelve false, si esta región no es válida, pero puede utilizarse con seguridad incluso en este caso.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Esta operación combina las partes de «esta» región que no forman parte de la segunda región. El resultado se almacena en esta región.

Union()

bool wxRegion::Union(const wxBitmap & bmp)

Busca la unión de esta región y los píxeles no transparentes de un mapa de bits.

La máscara del mapa de bits se utiliza para determinar la transparencia. Si el mapa de bits no tiene máscara, se utilizan las dimensiones completas del mapa de bits.

Valor de retorno

true en caso de éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región. El resultado se almacena en esta región.

Union()

bool wxRegion::Union( const wxBitmap & bmp, const wxColour & transColour, int tolerance = 0 )

Busca la unión de esta región y los píxeles no transparentes de un mapa de bits.

El color que debe tratarse como transparente se especifica en el argumento transColor, junto con un valor opcional de tolerancia de color.

Valor de retorno

true en caso de éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región. El resultado se almacena en esta región.

Union()

bool wxRegion::Union(const wxRect & rect)

Encuentra la unión de esta región y otra región rectangular.

Este método se puede utilizar incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual al rectángulo dado.

Valor de retorno

true en caso de éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región. El resultado se almacena en esta región.

Union()

bool wxRegion::Union(const wxRegion & region)

Encuentra la unión de esta región y otra región.

Este método puede utilizarse incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual a la región dada.

Valor de retorno

true en caso de éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región. El resultado se almacena en esta región.

Union()

bool wxRegion::Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height )

Busca la unión de esta región y otra región rectangular, especificada mediante la posición y el tamaño.

Este método se puede utilizar incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual al rectángulo dado.

Valor de retorno

true en caso de éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región. El resultado se almacena en esta región.

Xor()

bool wxRegion::Xor(const wxRect & rect)

Encuentra el Xor de esta región y otra región rectangular.

Este método se puede utilizar incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual al rectángulo dado.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región, excepto las áreas superpuestas. El resultado se almacena en esta región.

Xor()

bool wxRegion::Xor(const wxRegion & region)

Encuentra el Xor de esta región y otra región.

Este método se puede utilizar incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual a la región dada.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región, excepto las áreas superpuestas. El resultado se almacena en esta región.

Xor()

bool wxRegion::Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height )

Busca el Xor de esta región y otra región rectangular, especificada mediante la posición y el tamaño.

Este método se puede utilizar incluso si esta región no es válida y tiene el comportamiento natural en este caso, es decir, hace que esta región sea igual al rectángulo dado.

Valor de retorno

true si tiene éxito, false en caso contrario.

Observaciones

Esta operación crea una región que combina toda esta región y la segunda región, excepto las áreas superpuestas. El resultado se almacena en esta región.

Operadores

operator=()

wxRegion& wxRegion::operator=(const wxRegion & region)

Operador de asignación, utilizando Reference Counting.

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxGDIObject y wxObject.