#include <DgnRaster.h>

Inheritance diagram for DgnRaster:

Public Member Functions
RASTERCORE_EXPORT DgnRasterOpenParamsCR	GetOpenParams () const
	Query parameters that are used to open the raster source. More...

RASTERCORE_EXPORT StatusInt	AddToModel ()
	Add this DgnRaster to the DgnModel. This DgnRaster will be owned by the modelRef raster collection. See DgnRasterCollection. More...

RASTERCORE_EXPORT DgnRasterPtr	DeleteFromModel ()
	Delete this DgnRaster from the DgnModel. More...

RASTERCORE_EXPORT StatusInt	ReplaceInModel ()
	Write this DgnRaster definition to the DgnModel. Call this after calling any Set methods. More...

RASTERCORE_EXPORT ElementRefP	GetElementRef () const
	Gets the ElementRefP of the persistent storage of this DgnRaster. May be NULL. More...

RASTERCORE_EXPORT DgnModelRefP	GetModelRefP () const
	Gets the DgnModelRef to which this DgnRaster applies. More...

RASTERCORE_EXPORT DgnPlatform::LevelId	GetLevel () const
	Get the level of the attachment in the model that contains it. More...

RASTERCORE_EXPORT void	SetLevel (DgnPlatform::LevelId level)
	Assign the attachment itself to a level in the parent file. More...

RASTERCORE_EXPORT WStringCR	GetDescription () const
	Gets description. More...

RASTERCORE_EXPORT void	SetDescription (WCharCP description)
	Change raster attachment description. More...

RASTERCORE_EXPORT WStringCR	GetLogicalName () const
	Gets logical name. More...

RASTERCORE_EXPORT void	SetLogicalName (WCharCP logicalName)

RASTERCORE_EXPORT bool	GetSnappableState () const
	Query if snap is enable for this raster. More...

RASTERCORE_EXPORT void	SetSnappableState (bool state)
	Change if snap is enable for this raster. More...

RASTERCORE_EXPORT bool	GetLockedState () const
	Query if lock is set for this raster. More...

RASTERCORE_EXPORT void	SetLockedState (bool state)
	Change the lock state for this raster. More...

RASTERCORE_EXPORT bool	GetViewIndependentState () const
	Query if this raster display is view independent. More...

RASTERCORE_EXPORT void	SetViewIndependentState (bool state)
	Change view independent display state for this attachment. More...

RASTERCORE_EXPORT bool	GetGCSInheritedFromModelState () const
	Query if raster Geographic Coordinate System is inherited from the DgnModel raster is attached to. More...

RASTERCORE_EXPORT void	SetGCSInheritedFromModelState (bool state)
	Change if raster Geographic Coordinate System is inherited from the DgnModel or not. More...

RASTERCORE_EXPORT TransformCR	GetTransform () const
	Query raster attachment transformation matrix (pixel to UOR). More...

RASTERCORE_EXPORT void	SetTransform (TransformCR georef)
	Change raster attachment transformation matrix (pixel to UOR). More...

RASTERCORE_EXPORT DPoint2dCR	GetScanningResolution () const
	Query scanning resolution (in dot per inches (DPI), in x and y directions). More...

RASTERCORE_EXPORT void	SetScanningResolution (DPoint2dCR scanningResolutionDPI)
	Change scanning resolution (in dot per inches (DPI), in x and y directions). More...

RASTERCORE_EXPORT bool	GetViewState (int viewNumber) const
	Query if the raster is displayed in a specific view. More...

RASTERCORE_EXPORT void	SetViewState (int viewNumber, bool state)
	Change if the raster is displayed in a specific view. More...

RASTERCORE_EXPORT bool	GetInvertState () const
	Query if raster color must be inverted on display. More...

RASTERCORE_EXPORT void	SetInvertState (bool state)
	Change if raster color must be inverted on display. More...

RASTERCORE_EXPORT bool	GetPrintState () const
	Query if raster must be print. More...

RASTERCORE_EXPORT void	SetPrintState (bool state)
	Change if raster must be print. More...

RASTERCORE_EXPORT bool	GetClipState () const
	Query if raster clip properties are applied at display time. More...

RASTERCORE_EXPORT void	SetClipState (bool state)
	Change if raster clip properties are applied at display time. More...

RASTERCORE_EXPORT bool	GetTransparencyState () const
	Query if transparency must be displayed. More...

RASTERCORE_EXPORT void	SetTransparencyState (bool state)
	Change if transparency must be displayed. More...

RASTERCORE_EXPORT bool	GetBinaryPrintInvertState () const
	Query if background and foreground color should be inverted for binary raster file during print. More...

RASTERCORE_EXPORT void	SetBinaryPrintInvertState (bool state)
	Change if background and foreground color should be inverted for binary raster file during print. More...

RASTERCORE_EXPORT DgnPlatform::RasterDisplayPriorityPlane	GetDisplayPriorityPlane () const
	Query the RasterDisplayPriorityPlane value. More...

RASTERCORE_EXPORT void	SetDisplayPriorityPlane (DgnPlatform::RasterDisplayPriorityPlane plane)
	Change the RasterDisplayPriorityPlane value. More...

RASTERCORE_EXPORT double	GetViewGamma () const
	Query gamma value used to display raster in views. Zero is illegal and no gamma = 1.0. More...

RASTERCORE_EXPORT void	SetViewGamma (double gamma)
	Change gamma value used to display raster in views. More...

RASTERCORE_EXPORT double	GetPrintGamma () const
	Query gamma value used to print raster. Zero is illegal and no gamma = 1.0. More...

RASTERCORE_EXPORT void	SetPrintGamma (double gamma)
	Change gamma value used to print raster. More...

RASTERCORE_EXPORT UInt32	GetTintColor () const
	Query raw color index used to tint raster. More...

RASTERCORE_EXPORT void	SetTintColor (UInt32 rawColorIndex)
	Change raw color index used to tint raster. More...

RASTERCORE_EXPORT UInt32	GetForegroundColor () const
	Query raw color index used as foreground color. More...

RASTERCORE_EXPORT void	SetForegroundColor (UInt32 rawColorIndex)
	Change raw color index used as foreground color. More...

RASTERCORE_EXPORT UInt32	GetBackgroundColor () const
	Query raw color index used as background color. More...

RASTERCORE_EXPORT void	SetBackgroundColor (UInt32 rawColorIndex)
	Change raw color index used as background color. More...

RASTERCORE_EXPORT Int8	GetContrast () const
	Query contrast apply at display [-128, +127], 0 -> nothing. More...

RASTERCORE_EXPORT void	SetContrast (Int8 contrast)
	Change contrast apply at display [-128,+127], 0 -> nothing. More...

RASTERCORE_EXPORT Int8	GetBrightness () const
	Query brightness apply at display [-128, +127], 0 -> nothing. More...

RASTERCORE_EXPORT void	SetBrightness (Int8 brightness)
	Change brightness apply at display [-128,+127], 0 -> nothing. More...

RASTERCORE_EXPORT UInt8	GetImageTransparencyLevel () const
	Query transparency value applied to all raster image at display [0, 255], 0 -> Opaque. More...

RASTERCORE_EXPORT void	SetImageTransparencyLevel (UInt8 transparency)
	Change transparency value applied to all raster image at display [0,255], 0 -> Opaque. More...

RASTERCORE_EXPORT UInt8	GetBackgroundTransparencyLevel () const
	Get background transparency level. Binary raster only. [0,255], 0 -> Opaque. More...

RASTERCORE_EXPORT void	SetBackgroundTransparencyLevel (UInt8 transparency)
	Set background transparency level. Binary raster only. [0,255], 0 -> Opaque. More...

RASTERCORE_EXPORT UInt8	GetForegroundTransparencyLevel () const
	Get foreground transparency level. Binary raster only. [0,255], 0 -> Opaque. More...

RASTERCORE_EXPORT void	SetForegroundTransparencyLevel (UInt8 transparency)
	Set foreground transparency level. Binary raster only. [0,255], 0 -> Opaque. More...

RASTERCORE_EXPORT TransparentColorRgbArray const &	GetTransparentColors (TransparentColorRgbArray &transparentColors) const
	Query transparent color set on this raster attachment. More...

RASTERCORE_EXPORT void	SetTransparentColors (TransparentColorRgbArray const &transparentColors)
	Change transparent color set on this raster attachment. More...

RASTERCORE_EXPORT DgnGCSCP	GetDgnGCSCP () const
	Query a pointer to the object that describe the geographic coordinate system (geocoding) for this raster attachment. Can be NULL. More...

RASTERCORE_EXPORT void	SetDgnGCS (DgnGCSCP RasterDgnGCS)
	Change the geographic coordinate system (geocoding) for this raster attachment. More...

RASTERCORE_EXPORT RasterClipPropertiesCR	GetClipProperties () const
	Query clipProperties set on this raster attachment. More...

RASTERCORE_EXPORT StatusInt	SetClipProperties (RasterClipPropertiesPtr &clipProp)
	Change clipProperties set on this raster attachment. More...

RASTERCORE_EXPORT bool	IsReadOnly () const
	Determine if this raster has read-only access to the source. This is the effective access mode and may differ from what is stored in the element. More...

RASTERCORE_EXPORT RasterSourceCP	GetRasterSourceCP () const
	Get the RasterSource of this raster. May be NULL. More...

Static Public Member Functions
static RASTERCORE_EXPORT DgnRasterPtr	Create (DgnRasterStatus &status, DgnRasterOpenParamsR openParams, DgnModelRefR modelRef)
	Create a new DgnRaster with provided open parameters. More...

static RASTERCORE_EXPORT bool	IsLogicalNameUnique (WCharCP logicalName, DgnModelRefR dgnModel)
	Validate logical name uniqueness. More...

Member Function Documentation

RASTERCORE_EXPORT StatusInt AddToModel ( )

Add this DgnRaster to the DgnModel. This DgnRaster will be owned by the modelRef raster collection. See DgnRasterCollection.

static RASTERCORE_EXPORT DgnRasterPtr Create	(	DgnRasterStatus &	status,
		DgnRasterOpenParamsR	openParams,
		DgnModelRefR	modelRef
	)

static

Create a new DgnRaster with provided open parameters.

RASTERCORE_EXPORT DgnRasterPtr DeleteFromModel ( )

Delete this DgnRaster from the DgnModel.

RASTERCORE_EXPORT UInt32 GetBackgroundColor ( ) const

Query raw color index used as background color.

See also: RgbFromColorIndexInModel

RASTERCORE_EXPORT UInt8 GetBackgroundTransparencyLevel ( ) const

Get background transparency level. Binary raster only. [0,255], 0 -> Opaque.

RASTERCORE_EXPORT bool GetBinaryPrintInvertState ( ) const

Query if background and foreground color should be inverted for binary raster file during print.

Remarks: This setting has not effect if the raster file is not binary.

RASTERCORE_EXPORT Int8 GetBrightness ( ) const

Query brightness apply at display [-128, +127], 0 -> nothing.

RASTERCORE_EXPORT RasterClipPropertiesCR GetClipProperties ( ) const

Query clipProperties set on this raster attachment.

RASTERCORE_EXPORT bool GetClipState ( ) const

Query if raster clip properties are applied at display time.

RASTERCORE_EXPORT Int8 GetContrast ( ) const

Query contrast apply at display [-128, +127], 0 -> nothing.

RASTERCORE_EXPORT WStringCR GetDescription ( ) const

Gets description.

RASTERCORE_EXPORT DgnGCSCP GetDgnGCSCP ( ) const

Query a pointer to the object that describe the geographic coordinate system (geocoding) for this raster attachment. Can be NULL.

RASTERCORE_EXPORT DgnPlatform::RasterDisplayPriorityPlane GetDisplayPriorityPlane ( ) const

Query the RasterDisplayPriorityPlane value.

RASTERCORE_EXPORT ElementRefP GetElementRef ( ) const

Gets the ElementRefP of the persistent storage of this DgnRaster. May be NULL.

RASTERCORE_EXPORT UInt32 GetForegroundColor ( ) const

Query raw color index used as foreground color.

See also: RgbFromColorIndexInModel

Returns: raw color index used as foreground color.

RASTERCORE_EXPORT UInt8 GetForegroundTransparencyLevel ( ) const

Get foreground transparency level. Binary raster only. [0,255], 0 -> Opaque.

RASTERCORE_EXPORT bool GetGCSInheritedFromModelState ( ) const

Query if raster Geographic Coordinate System is inherited from the DgnModel raster is attached to.

RASTERCORE_EXPORT UInt8 GetImageTransparencyLevel ( ) const

Query transparency value applied to all raster image at display [0, 255], 0 -> Opaque.

RASTERCORE_EXPORT bool GetInvertState ( ) const

Query if raster color must be inverted on display.

RASTERCORE_EXPORT DgnPlatform::LevelId GetLevel ( ) const

Get the level of the attachment in the model that contains it.

RASTERCORE_EXPORT bool GetLockedState ( ) const

Query if lock is set for this raster.

RASTERCORE_EXPORT WStringCR GetLogicalName ( ) const

Gets logical name.

RASTERCORE_EXPORT DgnModelRefP GetModelRefP ( ) const

Gets the DgnModelRef to which this DgnRaster applies.

RASTERCORE_EXPORT DgnRasterOpenParamsCR GetOpenParams ( ) const

Query parameters that are used to open the raster source.

Remarks: This may not correspond to the effective parameters.

RASTERCORE_EXPORT double GetPrintGamma ( ) const

Query gamma value used to print raster. Zero is illegal and no gamma = 1.0.

RASTERCORE_EXPORT bool GetPrintState ( ) const

Query if raster must be print.

RASTERCORE_EXPORT RasterSourceCP GetRasterSourceCP ( ) const

Get the RasterSource of this raster. May be NULL.

RASTERCORE_EXPORT DPoint2dCR GetScanningResolution ( ) const

Query scanning resolution (in dot per inches (DPI), in x and y directions).

RASTERCORE_EXPORT bool GetSnappableState ( ) const

Query if snap is enable for this raster.

RASTERCORE_EXPORT UInt32 GetTintColor ( ) const

Query raw color index used to tint raster.

See also: RgbFromColorIndexInModel

RASTERCORE_EXPORT TransformCR GetTransform ( ) const

Query raster attachment transformation matrix (pixel to UOR).

RASTERCORE_EXPORT bool GetTransparencyState ( ) const

Query if transparency must be displayed.

RASTERCORE_EXPORT TransparentColorRgbArray const& GetTransparentColors ( TransparentColorRgbArray & transparentColors ) const

Query transparent color set on this raster attachment.

Parameters

[out] transparentColors Transparent colors array that will be filled.

Returns: a const reference to input transparent colors array.

RASTERCORE_EXPORT double GetViewGamma ( ) const

Query gamma value used to display raster in views. Zero is illegal and no gamma = 1.0.

RASTERCORE_EXPORT bool GetViewIndependentState ( ) const

Query if this raster display is view independent.

RASTERCORE_EXPORT bool GetViewState ( int viewNumber ) const

Query if the raster is displayed in a specific view.

Parameters

[in] viewNumber The view number to query [0..7].

static RASTERCORE_EXPORT bool IsLogicalNameUnique	(	WCharCP	logicalName,
		DgnModelRefR	dgnModel
	)

static

Validate logical name uniqueness.

RASTERCORE_EXPORT bool IsReadOnly ( ) const

Determine if this raster has read-only access to the source. This is the effective access mode and may differ from what is stored in the element.

RASTERCORE_EXPORT StatusInt ReplaceInModel ( )

Write this DgnRaster definition to the DgnModel. Call this after calling any Set methods.

RASTERCORE_EXPORT void SetBackgroundColor ( UInt32 rawColorIndex )

Change raw color index used as background color.

Parameters

[in] rawColorIndex The raw color index used as background color.

See also: RgbFromColorIndexInModel ColorIndexFromRgbInModel

RASTERCORE_EXPORT void SetBackgroundTransparencyLevel ( UInt8 transparency )

Set background transparency level. Binary raster only. [0,255], 0 -> Opaque.

RASTERCORE_EXPORT void SetBinaryPrintInvertState ( bool state )

Change if background and foreground color should be inverted for binary raster file during print.

Remarks: This setting has not effect if the raster file is not binary.

RASTERCORE_EXPORT void SetBrightness ( Int8 brightness )

Change brightness apply at display [-128,+127], 0 -> nothing.

Parameters

[in] brightness The brightness apply at display [-128,+127], 0 -> nothing.

RASTERCORE_EXPORT StatusInt SetClipProperties ( RasterClipPropertiesPtr & clipProp )

Change clipProperties set on this raster attachment.

RASTERCORE_EXPORT void SetClipState ( bool state )

Change if raster clip properties are applied at display time.

RASTERCORE_EXPORT void SetContrast ( Int8 contrast )

Change contrast apply at display [-128,+127], 0 -> nothing.

Parameters

[in] contrast The contrast apply at display [-128,+127], 0 -> nothing.

RASTERCORE_EXPORT void SetDescription ( WCharCP description )

Change raster attachment description.

Parameters

[in] description The new description.

RASTERCORE_EXPORT void SetDgnGCS ( DgnGCSCP RasterDgnGCS )

Change the geographic coordinate system (geocoding) for this raster attachment.

Parameters

[in] RasterDgnGCS The class that describe the geographic coordinate system (geocoding) to set. DgnRaster will take ownership of the object.

RASTERCORE_EXPORT void SetDisplayPriorityPlane ( DgnPlatform::RasterDisplayPriorityPlane plane )

Change the RasterDisplayPriorityPlane value.

RASTERCORE_EXPORT void SetForegroundColor ( UInt32 rawColorIndex )

Change raw color index used as foreground color.

Parameters

[in] rawColorIndex The raw color index used as foreground color.

See also: RgbFromColorIndexInModel ColorIndexFromRgbInModel

RASTERCORE_EXPORT void SetForegroundTransparencyLevel ( UInt8 transparency )

Set foreground transparency level. Binary raster only. [0,255], 0 -> Opaque.

RASTERCORE_EXPORT void SetGCSInheritedFromModelState ( bool state )

Change if raster Geographic Coordinate System is inherited from the DgnModel or not.

RASTERCORE_EXPORT void SetImageTransparencyLevel ( UInt8 transparency )

Change transparency value applied to all raster image at display [0,255], 0 -> Opaque.

Parameters

[in] transparency The transparency value applied to all raster image at display [0,255], 0 -> Opaque.

RASTERCORE_EXPORT void SetInvertState ( bool state )

Change if raster color must be inverted on display.

RASTERCORE_EXPORT void SetLevel ( DgnPlatform::LevelId level )

Assign the attachment itself to a level in the parent file.

RASTERCORE_EXPORT void SetLockedState ( bool state )

Change the lock state for this raster.

RASTERCORE_EXPORT void SetLogicalName ( WCharCP logicalName )

Parameters

[in] logicalName The new logical name.

RASTERCORE_EXPORT void SetPrintGamma ( double gamma )

Change gamma value used to print raster.

Parameters

[in] gamma The new gamma value used to print raster (0 is illegal and no gamma = 1.0).

RASTERCORE_EXPORT void SetPrintState ( bool state )

Change if raster must be print.

RASTERCORE_EXPORT void SetScanningResolution ( DPoint2dCR scanningResolutionDPI )

Change scanning resolution (in dot per inches (DPI), in x and y directions).

RASTERCORE_EXPORT void SetSnappableState ( bool state )

Change if snap is enable for this raster.

RASTERCORE_EXPORT void SetTintColor ( UInt32 rawColorIndex )

Change raw color index used to tint raster.

Parameters

[in] rawColorIndex The raw color index used to tint raster.

See also: RgbFromColorIndexInModel ColorIndexFromRgbInModel

RASTERCORE_EXPORT void SetTransform ( TransformCR georef )

Change raster attachment transformation matrix (pixel to UOR).

RASTERCORE_EXPORT void SetTransparencyState ( bool state )

Change if transparency must be displayed.

RASTERCORE_EXPORT void SetTransparentColors ( TransparentColorRgbArray const & transparentColors )

Change transparent color set on this raster attachment.

Parameters

[in] transparentColors The transparent colors to set.

RASTERCORE_EXPORT void SetViewGamma ( double gamma )

Change gamma value used to display raster in views.

Parameters

[in] gamma The gamma value used to display raster in views (0 is illegal and no gamma = 1.0).

RASTERCORE_EXPORT void SetViewIndependentState ( bool state )

Change view independent display state for this attachment.

RASTERCORE_EXPORT void SetViewState	(	int	viewNumber,
		bool	state
	)

Change if the raster is displayed in a specific view.

Parameters

[in]	viewNumber	The view number to query [0..7].
[in]	state	Set to true if the raster is displayed in the view.

The documentation for this struct was generated from the following file:

DgnRaster.h

Public Member Functions

Static Public Member Functions

Member Function Documentation