GeClipMap Class Reference | C4D R23.110 C++ SDK - 中文文档编制,帮助,手册,教程

GeClipMap Class Reference Library » Clipmap

#include <lib_clipmap.h>

详细描述

This class stores and manipulates a bitmap, providing more advanced drawing tools than BaseBitmap .
Be sure to call Init() before trying to use a newly allocated clip map.

注意: Though clip maps support other bit depths than 32 , the functionality is severely limited.
It is recommended that the clip map class is only used for 32 bit bitmaps. (Please note that the default bit depth for BaseBitmap is 24 ).; Has to be created with Alloc() and destroyed with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

私有成员函数
	GeClipMap ()
	~GeClipMap ()

Alloc/Free
static GeClipMap *	Alloc ()
static void	Free ( GeClipMap *&data)

Init
IMAGERESULT	Init ( Int32 w, Int32 h, Int32 bits)
IMAGERESULT	Init ( BaseBitmap *bm)
IMAGERESULT	Init ( BaseBitmap bm, BaseBitmap alpha_channel)
IMAGERESULT	Init (const Filename &name, Int32 frame, Bool *ismovie)
IMAGERESULT	Init (const IconData &iconData)
IMAGERESULT	Init ( GeUserArea *userArea, Int32 x, Int32 y, Int32 w, Int32 h)

Destroy
void	Destroy ()

维度
void	GetDim ( Int32 w, Int32 h) const
Int32	GetBw () const
Int32	GetBh () const

Bitmap
BaseBitmap *	GetBitmap ()
const BaseBitmap *	GetBitmap () const

Begin/End Draw
void	BeginDraw ()
void	EndDraw ()

Set Offset/Draw Mode/Color
void	SetOffset ( Int32 off_x, Int32 off_y)
void	SetDrawMode ( GE_CM_DRAWMODE 模式， UInt32 par)
void	SetColor ( Int32 r, Int32 g, Int32 b, Int32 a=255)

Drawing
void	SetPixel ( Int32 x, Int32 y)
void	Line ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)
void	PolyLine ( Int32 cnt, GE_POINT2D *points)
Bool	SupportsDrawBezierSegment () const
void	DrawBezierSegment (const maxon::Vector2d *p)
void	FillPolygon ( Int32 cnt, GE_POINT2D *points)
void	Rect ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)
void	FillRect ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)
void	Arc ( Int32 x1, Int32 y1, Int32 x2, Int32 y2, GE_CM_ARCSEGMENT seg)
void	FillArc ( Int32 x1, Int32 y1, Int32 x2, Int32 y2, GE_CM_ARCSEGMENT seg)
void	Ellipse ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)
void	FillEllipse ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)

Get/Set Pixel
void	GetPixelRGBA ( Int32 x, Int32 y, Int32 r, Int32 g, Int32 b, Int32 a)
void	SetPixelRGBA ( Int32 x, Int32 y, Int32 r, Int32 g, Int32 b, Int32 a=255)

Text
void	TextAt ( Int32 x, Int32 y, const String &txt)
Int32	GetTextWidth (const String &txt)
Int32	GetTextHeight ()
Int32	GetTextAscent ()

Blit
void	Blit ( Int32 dx, Int32 dy, const GeClipMap &s_dp, Int32 sx1, Int32 sy1, Int32 sx2, Int32 sy2, GE_CM_BLIT rop)

裁剪
void	SetClipRgn ( Int32 left, Int32 top, Int32 right, Int32 bottom)
void	SetClipRgn ( GE_POINT2D *points, Int32 count, GE_CM_CLIPREGION mode)
Bool	ClipPoint ( Int32 x, Int32 y)
Int32	ClipArea ( Int32 x1, Int32 y1, Int32 x2, Int32 y2)

字体
static Bool	GetFontName ( BaseContainer const font_description, GeFontNameType type, String dst)
static Bool	GetFontDescription ( String const &name, GeFontNameType type, BaseContainer *dst)
static void	EnumerateFonts ( BaseContainer *dst, GE_CM_FONTSORT sort_mode)
static Bool	GetDefaultFont ( GeFontDefaultType type, BaseContainer *font_description)
static Bool	GetFontSize ( BaseContainer const font_description, GeFontSizeType type, Float size)
static Bool	SetFontSize ( BaseContainer *font_description, GeFontSizeType type, Float size)
Bool	SetFont ( BaseContainer const *font_description, Float font_size=0.0)
Float	GetFont ( BaseContainer *font_description)

构造函数 & 析构函数文档编制

◆ GeClipMap()

GeClipMap () private

◆ ~GeClipMap()

成员函数文档编制

◆ Alloc()

Allocates a clip map. Destroy the allocated clip map with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

◆ Free()

Destructs clip maps allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

◆ Init() [1/6]

Initializes the clip map bitmap to the given dimensions and depth. Any previous data is lost.

◆ Init() [2/6]

◆ Init() [3/6]

Loads the clip map bitmap from bm with the specified alpha channel. Any previous data is lost.

◆ Init() [4/6]

Loads the clip map bitmap from the file specified by name . The file can be either a movie or a picture. The file format is automatically detected. Any previous data is lost.

◆ Init() [5/6]

◆ Init() [6/6]

◆ Destroy()

Resets the clip map to its initial state and frees allocated memory.
Requires a new call to Init() before the clip map can be used again.

◆ GetDim()

◆ GetBw()

◆ GetBh()

◆ GetBitmap() [1/2]

◆ GetBitmap() [2/2]

◆ BeginDraw()

◆ EndDraw()

Must be called after a sequence of drawing functions to free the memory allocated by BeginDraw() .

◆ SetOffset()

◆ SetDrawMode()

◆ SetColor()

◆ SetPixel()

◆ Line()

◆ PolyLine()

◆ SupportsDrawBezierSegment()

SupportsDrawBezierSegment returns true if the clipmap supports DrawBezierSegment() .

◆ DrawBezierSegment()

◆ FillPolygon()

◆ Rect()

Draws the outline of a rectangle from ( x1 , y1 ) to ( x2 , y2 ) with the draw color.

◆ FillRect()

◆ Arc()

Draws an arc within the rectangle from ( x1 , y1 ) to ( x2 , y2 ) with the draw color.

◆ FillArc()

Fills an arc within the rectangle from ( x1 , y1 ) to ( x2 , y2 ) with the draw color.

◆ Ellipse()

Draws an ellipse within the rectangle from ( x1 , y1 ) to ( x2 , y2 ) with the draw color.

◆ FillEllipse()

Fills an ellipse within the rectangle from ( x1 , y1 ) to ( x2 , y2 ) with the draw color.

◆ GetPixelRGBA()

◆ SetPixelRGBA()

◆ TextAt()

◆ GetTextWidth()

◆ GetTextHeight()

◆ GetTextAscent()

Calculates the ascent in the current font. This is the distance from the baseline to the ascender line and usually represents the height of capital letters.

◆ Blit()

Blits from s_dp to the clip map.
The region ( sx1 , sy1 ) to ( sx2 , sy2 ) from the source will be copied into the region with the top left corner at ( dx , dy ) in the destination. Additionally specify a raster operation with rop .

◆ SetClipRgn() [1/2]

Sets the clipping region of the clip map. This affects all drawing commands so that nothing is drawn outside the region specified by ( left , top ) to ( right , bottom ).

◆ SetClipRgn() [2/2]

Sets the stored region to the inside of the polygonal path specified by the points array.

◆ ClipPoint()

◆ ClipArea()

◆ SetFont()

◆ GetFont()

◆ GetFontName()

◆ GetFontDescription()

◆ EnumerateFonts()

Enumerates all fonts and returns them in a container.
For each font a container (font description) will be inserted. They can be used for SetFont() , GetFontName() or as input for GeChooseFont() .

[in]	w	The width in pixels.
[in]	h	The height in pixels.
[in]	bits	The requested bit depth. The possible values are { 1 , 4 , 8 , 16 , 24 , 32} . On some platforms 32 bits will be used even if 24 is requested, to allow for padding.

[in]	bm	The bitmap to initialize the clip map with. The caller owns the pointed bitmap.
[in]	alpha_channel	The alpha channel to use in bm . The caller owns the pointed bitmap.

[in]	name	A valid filename.
[in]	frame	The frame number to load in a movie.
[out]	ismovie	If not nullptr this is assigned true if the loaded picture was a movie, and false otherwise.

void GetDim	(	Int32 *	w ,
		Int32 *	h
	)		const

[in]	w	Assigned the width.
[in]	h	Assigned the height.

IMAGERESULT Init	(	BaseBitmap *	bm ,
		BaseBitmap *	alpha_channel
	)

IMAGERESULT Init	(	const Filename &	name ,
		Int32	frame ,
		Bool *	ismovie
	)

IMAGERESULT Init	(	GeUserArea *	userArea ,
		Int32	x ,
		Int32	y ,
		Int32	w ,
		Int32	h
	)

[in]	off_x	The X distance in pixels.
[in]	off_y	The Y distance in pixels.

[in]	mode	The draw mode: GE_CM_DRAWMODE
[in]	par	The parameter, depends on mode .

[in]	r	The red value. (Between 0 and 255 .)
[in]	g	The green value. (Between 0 and 255 .)
[in]	b	The blue value. (Between 0 and 255 .)
[in]	a	The alpha value. (Between 0 and 255 .)

[in]	x1	The first X coordinate.
[in]	y1	The first Y coordinate.
[in]	x2	The second X coordinate.
[in]	y2	The second Y coordinate.

[in]	cnt	The number of elements in points .
[in]	points	The points in the polygon line. The caller owns the pointed array.

[in]	x1	The top left X coordinate.
[in]	y1	The top left Y coordinate.
[in]	x2	The bottom right X coordinate.
[in]	y2	The bottom right Y coordinate.

void Arc	(	Int32	x1 ,
		Int32	y1 ,
		Int32	x2 ,
		Int32	y2 ,
		GE_CM_ARCSEGMENT	seg
	)

void FillArc	(	Int32	x1 ,
		Int32	y1 ,
		Int32	x2 ,
		Int32	y2 ,
		GE_CM_ARCSEGMENT	seg
	)

void GetPixelRGBA	(	Int32	x ,
		Int32	y ,
		Int32 *	r ,
		Int32 *	g ,
		Int32 *	b ,
		Int32 *	a
	)

[in]	x	The X coordinate.
[in]	y	The Y coordinate.
[out]	r	Assigned the red value. (Between 0 and 255 .)
[out]	g	Assigned the green value. (Between 0 and 255 .)
[out]	b	Assigned the blue value. (Between 0 and 255 .)
[out]	a	Assigned the alpha value. (Between 0 and 255 .)

void SetPixelRGBA	(	Int32	x ,
		Int32	y ,
		Int32	r ,
		Int32	g ,
		Int32	b ,
		Int32	a = `255`
	)

void Blit	(	Int32	dx ,
		Int32	dy ,
		const GeClipMap &	s_dp ,
		Int32	sx1 ,
		Int32	sy1 ,
		Int32	sx2 ,
		Int32	sy2 ,
		GE_CM_BLIT	rop
	)

[in]	dx	The top left destination X coordinate.
[in]	dy	The top left destination Y coordinate.
[in]	s_dp	The source.
[in]	sx1	The top left source X coordinate.
[in]	sy1	The top left source Y coordinate.
[in]	sx2	The bottom right source X coordinate.
[in]	sy2	The bottom right source Y coordinate.
[in]	rop	The raster operation: GE_CM_BLIT

void SetClipRgn	(	Int32	left ,
		Int32	top ,
		Int32	right ,
		Int32	bottom
	)

[in]	left	The left position of the clipping region.
[in]	top	The top position of the clipping region.
[in]	right	The right position of the clipping region.
[in]	bottom	The bottom position of the clipping region.

void SetClipRgn	(	GE_POINT2D *	points ,
		Int32	count ,
		GE_CM_CLIPREGION	mode
	)

[in]	points	An array of count points with the polygonal path. The caller owns the pointed array.
[in]	count	The number of elements in the points array.
[in]	mode	The method used to determine the inside of the path: GE_CM_CLIPREGION