RasterInfo

Stores information for painting pixels at a time into a 2D texture used with MaterialRaster. More...

Inheritance diagram for RasterInfo:

Collaboration diagram for RasterInfo:

Public Member Functions
	RasterInfo ()
	Default constructor.
	RasterInfo (const File &ini_file)
	Constructs a RasterInfo from an INI configuration file.
virtual void	getINI (INIFactory &factory) override
	Serializes or deserializes raster settings to/from an INI file via the factory.
bool	isEnabled () const
	Checks whether the raster is enabled and has a valid (non-zero) pixel size.
Public Member Functions inherited from INIInterface
	INIInterface ()
	Constructs an INIInterface with no default INI file.
	INIInterface (const File &default_ini)
	Constructs an INIInterface with the specified default INI file.
virtual	~INIInterface ()
	Virtual destructor for safe polymorphic cleanup.
virtual void	finishReadingINI (INIFactory &)
	Called after reading an INI file.
virtual void	prepareForINI (INIFactory &)
	Called before reading or writing an INI file.
virtual bool	readINIOptions ()
	Reads INI options from the default INI file.
virtual bool	readINIOptions (File &ini_file)
	Reads INI options from the specified INI file.
virtual bool	saveINIOptions (bool multithead=false)
	Saves INI options to the default INI file.
virtual bool	saveINIOptions (File &ini_file, bool multithead=false)
	Saves INI options to the specified INI file.
void	setDefaultINIFile (const File &file)
	Sets the default INI file path used for reading and writing options.
virtual void	writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log with a title.
virtual void	writeToLog (LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log.

Public Attributes
Vector< 2, Angle< fltp08 > >	angle_offset = Vector<2, Angle<fltp08>>(Angle<fltp08>(DEGREES, 0.0))
	Angular offset applied to the camera drape direction.
Vector< 2, Angle< fltp08 > >	camera_drape_move_angle = Vector<2, Angle<fltp08>>(Angle<fltp08>(DEGREES, 45.0))
	The angular range used when draping camera imagery onto the raster.
bool	is_enabled = false
	Whether rasterization is currently enabled.
Vector< 2, uint04 >	pixel_size = Vector<2, uint04>(0, 0)
	The width and height of the raster texture in pixels.
fltp08	radial_distortion_offset = 0
	Offset applied to radial distortion correction.
fltp08	radial_distortion_scale = 0.2
	Scale factor applied to radial distortion correction.
uint04	side_crop = 5
	Number of pixels to crop from each side of the source image.

Additional Inherited Members
Protected Attributes inherited from INIInterface
File	m_default_ini
	The default file path used for reading and writing INI options.

Detailed Description

Stores information for painting pixels at a time into a 2D texture used with MaterialRaster.

---

Definition at line 12 of file MaterialRaster.h.

Constructor & Destructor Documentation

RasterInfo() [1/2]

RasterInfo::RasterInfo ( )

inline

Default constructor.

Initializes with an empty File.

Definition at line 15 of file MaterialRaster.h.

References INIInterface::INIInterface().

RasterInfo() [2/2]

RasterInfo::RasterInfo ( const File & ini_file )

inline

Constructs a RasterInfo from an INI configuration file.

Parameters

[in]

ini_file

The INI file to load raster settings from.

Definition at line 21 of file MaterialRaster.h.

References INIInterface::INIInterface().

Member Function Documentation

getINI()

virtual void RasterInfo::getINI ( INIFactory & factory )

inlineoverridevirtual

Serializes or deserializes raster settings to/from an INI file via the factory.

Parameters

[in]

factory

The INIFactory used for reading or writing settings.

Implements INIInterface.

Definition at line 41 of file MaterialRaster.h.

References INIFactory::addOption(), angle_offset, camera_drape_move_angle, is_enabled, pixel_size, radial_distortion_offset, radial_distortion_scale, and side_crop.

isEnabled()

bool RasterInfo::isEnabled ( ) const

inline

Checks whether the raster is enabled and has a valid (non-zero) pixel size.

Returns

True if the raster is enabled and pixel_size is greater than zero.

Definition at line 27 of file MaterialRaster.h.

References is_enabled, and pixel_size.

---

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

• Design/Headers/MaterialRaster.h