Interface XCanvas

Devguide

Attributes' Summary

Attributes' Details

interface XCanvas

Methods' Summary
drawPoint	Draw a point in device resolution on the device.
drawLine	Draw a line in device resolution width (i.e. one device pixel wide).
drawBezier	Draw a cubic bezier curve in device resolution width (i.e. one device pixel wide).
drawPolyPolygon	Draw a polyPolygon in device resolution line width (i.e. the lines are one device pixel wide).
strokePolyPolygon	Stroke each polygon of the provided polyPolygon with the specified stroke attributes. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.
strokeTexturedPolyPolygon	Stroke each polygon of the provided polyPolygon with the specified stroke attributes, fill the stroked outline with the specified texture graphics. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.
strokeTextureMappedPolyPolygon	Stroke each polygon of the provided polyPolygon with the specified stroke attributes. Fill the stroked outline with the specified texture graphics, map the texture to the outline via the specified texture mapping. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.
queryStrokeShapes	Query the polygonal representation of the stroke outlines, as it would be generated by the stroke * PolyPolygon methods. This can be used to e.g. set a clipping which covers the same area as a stroke. [TODO: Method misplaced at this interface?]
fillPolyPolygon	Fill the given polyPolygon according to the RenderState's color and the specified fillRule.
fillTexturedPolyPolygon	Fill the given polyPolygon according to the RenderState's color, the given textures and the specified fillRule.
fillTextureMappedPolyPolygon	Fill the given polyPolygon according to the RenderState's color, the given textures and the specified fillRule. The texture is mapped to the polyPolygon's interior via the given texture mapping.
queryFont	Query a suitable font for the specified font description TODO: boolean IsVertical on FontDescriptor
drawText	Draw the text given by the substring of the specified string with the given font.
drawOffsettedText	Draw the text given by the substring of the specified string with the given font. Place every glyph at a position as specified by the offsets relative to the start of the string.
drawBitmap	Render the bitmap, at a position and shape as specified by the combined view and render transformations.
getDevice	Request the associated GraphicDevice of this canvas.

Methods' Details

drawPoint

void
drawPoint(

[in] Point2D
[in] ViewState
[in] RenderState

aPoint,
viewState,
renderState );

Description: Draw a point in device resolution on the device.

drawLine

void
drawLine(

[in] Point2D
[in] Point2D
[in] ViewState
[in] RenderState

aStartPoint,
aEndPoint,
viewState,
renderState );

Description: Draw a line in device resolution width (i.e. one device pixel wide).

drawBezier

void
drawBezier(

[in] Point2D
[in] Point2D
[in] Point2D
[in] Point2D
[in] ViewState
[in] RenderState

aStartPoint,
aFirstControlPoint,
aSecondControlPoint,
aEndPoint,
viewState,
renderState );

Description: Draw a cubic bezier curve in device resolution width (i.e. one device pixel wide).

drawPolyPolygon

XCachedPrimitive
drawPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState

xPolyPolygon,
viewState,
renderState );

Description: Draw a polyPolygon in device resolution line width (i.e. the lines are one device pixel wide).

strokePolyPolygon

XCachedPrimitive
strokePolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] StrokeAttributes

xPolyPolygon,
viewState,
renderState,
strokeAttributes );

Description: Stroke each polygon of the provided polyPolygon with the specified stroke attributes. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.

strokeTexturedPolyPolygon

XCachedPrimitive
strokeTexturedPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] sequence< Texture >
[in] StrokeAttributes

xPolyPolygon,
viewState,
renderState,
textures,
strokeAttributes );

Description: Stroke each polygon of the provided polyPolygon with the specified stroke attributes, fill the stroked outline with the specified texture graphics. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.

strokeTextureMappedPolyPolygon

XCachedPrimitive
strokeTextureMappedPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] sequence< Texture >
[in] XMapping2D
[in] StrokeAttributes

xPolyPolygon,
viewState,
renderState,
textures,
xMapping,
strokeAttributes );

Description: Stroke each polygon of the provided polyPolygon with the specified stroke attributes. Fill the stroked outline with the specified texture graphics, map the texture to the outline via the specified texture mapping. Consider the stroking of all polygons as an atomic operation in relation to the RenderState's CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.

queryStrokeShapes

XPolyPolygon2D
queryStrokeShapes(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] StrokeAttributes

xPolyPolygon,
viewState,
renderState,
strokeAttributes );

Description: Query the polygonal representation of the stroke outlines, as it would be generated by the stroke * PolyPolygon methods. This can be used to e.g. set a clipping which covers the same area as a stroke. [TODO: Method misplaced at this interface?]

fillPolyPolygon

XCachedPrimitive
fillPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] FillRule

xPolyPolygon,
viewState,
renderState,
fillRule );

Description: Fill the given polyPolygon according to the RenderState's color and the specified fillRule.

fillTexturedPolyPolygon

XCachedPrimitive
fillTexturedPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] sequence< Texture >
[in] FillRule

xPolyPolygon,
viewState,
renderState,
textures,
fillRule );

Description: Fill the given polyPolygon according to the RenderState's color, the given textures and the specified fillRule.

fillTextureMappedPolyPolygon

XCachedPrimitive
fillTextureMappedPolyPolygon(

[in] XPolyPolygon2D
[in] ViewState
[in] RenderState
[in] sequence< Texture >
[in] XMapping2D
[in] FillRule

xPolyPolygon,
viewState,
renderState,
textures,
xMapping,
fillRule );

Description: Fill the given polyPolygon according to the RenderState's color, the given textures and the specified fillRule. The texture is mapped to the polyPolygon's interior via the given texture mapping.

queryFont

XFont
queryFont(

[in] FontDescription

fontDescriptor );

Description: Query a suitable font for the specified font description TODO: boolean IsVertical on FontDescriptor

drawText

XCachedPrimitive
drawText(

[in] StringContext
[in] XFont
[in] ViewState
[in] RenderState
[in] sequence< double >
[in] boolean

text,
xFont,
viewState,
renderState,
backgroundColor,
textDirection );

Description: Draw the text given by the substring of the specified string with the given font.

drawOffsettedText

XCachedPrimitive
drawOffsettedText(

[in] StringContext
[in] XFont
[in] sequence< double >
[in] ViewState
[in] RenderState
[in] sequence< double >
[in] boolean

text,
xFont,
offsets,
viewState,
renderState,
backgroundColor,
textDirection );

Description: Draw the text given by the substring of the specified string with the given font. Place every glyph at a position as specified by the offsets relative to the start of the string.

drawBitmap

XCachedPrimitive
drawBitmap(

[in] XBitmap
[in] ViewState
[in] RenderState

xBitmap,
viewState,
renderState );

Description: Render the bitmap, at a position and shape as specified by the combined view and render transformations.

getDevice

XGraphicDevice
getDevice();

Description: Request the associated GraphicDevice of this canvas.

Top of Page