CDXBnds Access Functions

The following functions are used to get and set the minimum and maximum values stored in the CDXBnds data object.

Member Functions

Width( DXBNDID i ) Retrieves the width of the specified dimension.

Width Retrieves the width of the x-axis dimension.

Height Retrieves the height of the y-axis dimension.

Depth Retrieves the depth of the z-axis dimension.

Duration Retrieves the size of the t-axis dimension.

Left Retrieves the minimum x-axis value.

Right Retrieves the maximum x-axis value.

Top Retrieves the maximum y-axis value.

Bottom Retrieves the minimum y-axis value.

SetBounds Sets all of the values of the data object with the specified bounds.

SetXYRect Sets the x-axis and y-axis bounds of the object to the specified rectangle.

SetXYSize( const SIZE& xySize ) Sets the x-axis and y-axis bounds of the object to the specified size.

SetXYSize( TYPE width, TYPE height) Sets the x-axis and y-axis bounds of the object to the specified size.

SetXYPoint Sets the x-axis and y-axis bounds of the object to one pixel width at the specified point.

Offset( TYPE x, TYPE y, TYPE z, TYPE t ) Adds the specified values to the minimum and maximum for each dimension.

Offset( const CDXV_C& v ) Adds the specified vector to the minimum and maximum for each dimension.

SetPlacement Translates the bounds to the absolute position specified by the vector.

SetToSize Translates the bounds so that all the minimum values are positioned at zero.

GetXYRect Stores the x-axis and y-axis bounds into the specified rectangle.

GetXYSize Stores the x size and y size of the bounds in the specified SIZE structure.

GetMinVector Stores the minimum values for each dimension into the specified vector.

GetMaxVector Stores the maximum values for each dimension into the specified vector.

GetSize Retrieves the bounds translated so that the minimum values are positioned at zero.

Size Retrieves the bounds translated so that the minimum values are positioned at zero.

CDXBnds::Width( DXBNDID i )

CDXBnds Class

Retrieves the width of the specified dimension.

Syntax

USTYPE Width(
	DXBNDID i
);

Parameters

i
[in] ID of the bounding dimension for which to return the width.

Return Value

Returns the width of the dimension.

CDXBnds::Width

CDXBnds Class

Retrieves the width of the x-axis dimension.

Syntax

USTYPE Width(void);

Return Value

Returns the width of the bounds.

CDXBnds::Height

CDXBnds Class

Retrieves the height of the y-axis dimension.

Syntax

USTYPE Height(void);

Return Value

Returns the height of the bounds.

CDXBnds::Depth

CDXBnds Class

Retrieves the depth of the z-axis dimension.

Syntax

USTYPE Depth(void);

Return Value

Returns the depth of the bounds.

CDXBnds::Duration

CDXBnds Class

Retrieves the size of the t-axis dimension.

Syntax

USTYPE Duration(void);

Return Value

Returns the duration of the bounds.

CDXBnds::Left

CDXBnds Class

Retrieves the minimum x-axis value.

Syntax

TYPE Left(void);

Return Value

Returns the minimum x-axis value.

CDXBnds::Right

CDXBnds Class

Retrieves the maximum x-axis value.

Syntax

TYPE Right(void);

Return Value

Returns the maximum x-axis value.

CDXBnds::Top

CDXBnds Class

Retrieves the maximum y-axis value.

Syntax

TYPE Top(void);

Return Value

Returns the maximum y-axis value.

CDXBnds::Bottom

CDXBnds Class

Retrieves the minimum y-axis value.

Syntax

TYPE Bottom(void);

Return Value

Returns the minimum y-axis value.

CDXBnds::SetBounds

CDXBnds Class

Sets all the values of the data object with the specified bounds.

Syntax

void SetBounds(
	TYPE xmin,
	TYPE xmax,
	TYPE ymin,
	TYPE ymax,
	TYPE zmin,
	TYPE zmax,
	TYPE tmin,
	TYPE tmax 
);

Parameters

xmin
[in] Minimum x value.

xmax
[in] Maximum x value.

ymin
[in] Minimum y value.

ymax
[in] Maximum y value.

zmin
[in] Minimum z value.

zmax
[in] Maximum z value.

tmin
[in] Minimum t value.

tmax
[in] Maximum t value.

Return Value

No return value.

CDXBnds::SetXYRect

CDXBnds Class

Sets the x-axis and y-axis bounds of the object to the specified rectangle.

Syntax

void SetXYRect(
	const RECT &xyRect
);

Parameters

xyRect
[in] Rectangle to initialize the data object with.

Return Value

No return value.

Remarks

The z and t bounds are both set with minimum equal to zero and maximum equal to one.

CDXBnds::SetXYSize( const SIZE& xySize )

CDXBnds Class

Sets the x-axis and y-axis bounds of the object to the specified size.

Syntax

void SetXYSize(
	const SIZE &xySize
);

Parameters

xySize
[in] Size to initialize the data object with.

Return Value

No return value.

Remarks

The minimum values of the x and y dimensions are set to zero; the maximum values are set to xySize.cx and xySize.cy, respectively. The z and t bounds are both set with minimum equal to zero and maximum equal to one.

CDXBnds::SetXYSize( TYPE width, TYPE height )

CDXBnds Class

Sets the x-axis and y-axis bounds of the object to the specified size.

Syntax

void SetXYSize(
	TYPE width,
	TYPE height
);

Parameters

width
[in] Width to set along the x-axis.

height
[in] Width to set along the y-axis.

Return Value

No return value.

Remarks

The minimum values of the x and y dimensions are set to zero; the maximum values are set to width and height, respectively. The z and t bounds are both set with minimum equal to zero and maximum equal to one.

CDXBnds::SetXYPoint

CDXBnds Class

Sets the x-axis and y-axis bounds of the object to one pixel width at the specified point.

Syntax

void SetXYPoint(
	const POINT &xyPoint
);

Parameters

xyPoint
[in] Location of a point to use for the bounds.

Return Value

No return value.

Remarks

The z and t bounds are both set with minimum equal to zero and maximum equal to one.

CDXBnds::Offset( TYPE x, TYPE y, TYPE z, TYPE t )

CDXBnds Class

Adds the specified values to the minimum and maximum for each dimension.

Syntax

void Offset(
	TYPE x,
	TYPE y,
	TYPE z,
	TYPE t 
);

Parameters

x
[in] Value to add to the x minimum and maximum.

y
[in] Value to add to the y minimum and maximum.

z
[in] Value to add to the z minimum and maximum.

t
[in] Value to add to the t minimum and maximum.

Return Value

No return value.

CDXBnds::Offset( const CDXV_C& v )

CDXBnds Class

Adds the specified vector to the minimum and maximum for each dimension.

Syntax

void Offset(
	const CDXV_C &v 
);

Parameters

v
[in] Vector to add.

Return Value

No return value.

CDXBnds::SetPlacement

CDXBnds Class

Translates the bounds to the absolute position specified by the vector.

Syntax

void SetPlacement(
	const CDXV_C &v
);

Parameters

v
[in] Position at which to place the bounds.

Return Value

No return value.

CDXBnds::SetToSize

CDXBnds Class

Translates the bounds to the absolute position specified by the vector.

Syntax

void SetToSize(void);

Return Value

No return value.

CDXBnds::GetXYRect

CDXBnds Class

Stores the x-axis and y-axis bounds into the specified rectangle.

Syntax

void GetXYRect(
	RECT &xyRect
);

Parameters

xyRect
[out] Location of a RECT structure to store the x-axis and y-axis bounds.

Return Value

No return value.

CDXBnds::GetXYSize

CDXBnds Class

Stores the x and y size of the bounds into the specified SIZE structure.

Syntax

void GetXYSize(
	SIZE &xySize
);

Parameters

xySize
[out] Reference to a SIZE structure to store the x and y width and height of the bounds.

Return Value

No return value.

CDXBnds::GetMinVector

CDXBnds Class

Stores the minimum values for each dimension into the specified vector.

Syntax

void GetMinVector(
	CDXV_C &v
);

Parameters

v
[out] Location to store the minimum values for each dimension.

Return Value

No return value.

CDXBnds::GetMaxVector

CDXBnds Class

Stores the maximum values for each dimension into the specified vector.

Syntax

void GetMaxVector(
	CDXV_C &v
);

Parameters

v
[out] Location to store the maximum values for each dimension.

Return Value

No return value.

CDXBnds::GetSize

CDXBnds Class

Retrieves the bounds translated so that the minimum values are positioned at zero.

Syntax

void GetSize(
	CDXB_C &SizeBounds
);

Parameters

SizeBounds
[out] Location to return the size bounds.

Return Value

No return value.

Remarks

The minimum value along each dimension will always be set to zero; and the maximum value will always be the width of each dimension.

CDXBnds::Size

CDXBnds Class

Retrieves the bounds translated so that the minimum values are positioned at zero.

Syntax

CDXB_C Size(void);

Return Value

Returns the size of the specified CDXBnds object.

Remarks

The minimum value along each dimension will always be set to zero; and the maximum value will always be the width of each dimension.

Width( DXBNDID i )	Retrieves the width of the specified dimension.
Width	Retrieves the width of the x-axis dimension.
Height	Retrieves the height of the y-axis dimension.
Depth	Retrieves the depth of the z-axis dimension.
Duration	Retrieves the size of the t-axis dimension.
Left	Retrieves the minimum x-axis value.
Right	Retrieves the maximum x-axis value.
Top	Retrieves the maximum y-axis value.
Bottom	Retrieves the minimum y-axis value.
SetBounds	Sets all of the values of the data object with the specified bounds.
SetXYRect	Sets the x-axis and y-axis bounds of the object to the specified rectangle.
SetXYSize( const SIZE& xySize )	Sets the x-axis and y-axis bounds of the object to the specified size.
SetXYSize( TYPE width, TYPE height)	Sets the x-axis and y-axis bounds of the object to the specified size.
SetXYPoint	Sets the x-axis and y-axis bounds of the object to one pixel width at the specified point.
Offset( TYPE x, TYPE y, TYPE z, TYPE t )	Adds the specified values to the minimum and maximum for each dimension.
Offset( const CDXV_C& v )	Adds the specified vector to the minimum and maximum for each dimension.
SetPlacement	Translates the bounds to the absolute position specified by the vector.
SetToSize	Translates the bounds so that all the minimum values are positioned at zero.
GetXYRect	Stores the x-axis and y-axis bounds into the specified rectangle.
GetXYSize	Stores the x size and y size of the bounds in the specified SIZE structure.
GetMinVector	Stores the minimum values for each dimension into the specified vector.
GetMaxVector	Stores the maximum values for each dimension into the specified vector.
GetSize	Retrieves the bounds translated so that the minimum values are positioned at zero.
Size	Retrieves the bounds translated so that the minimum values are positioned at zero.