VTK
9.3.20240831
|
helper class for a ray cast image More...
#include <vtkFixedPointRayCastImage.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkFixedPointRayCastImage * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
unsigned short * | GetImage () |
Get the internal storage for the image. | |
void | AllocateImage () |
Call this method once the ImageMemorySize has been set the allocate the image. | |
void | ClearImage () |
Clear the image to (0,0,0,0) for each pixel. | |
float | GetZBufferValue (int x, int y) |
Get the ZBuffer value corresponding to location (x,y) where (x,y) are indexing into the ImageInUse image. | |
float * | GetZBuffer () |
Get the ZBuffer. | |
void | AllocateZBuffer () |
virtual void | SetImageViewportSize (int, int) |
Set / Get the ImageViewportSize. | |
void | SetImageViewportSize (int[2]) |
Set / Get the ImageViewportSize. | |
virtual int * | GetImageViewportSize () |
Set / Get the ImageViewportSize. | |
virtual void | GetImageViewportSize (int data[2]) |
Set / Get the ImageViewportSize. | |
virtual void | SetImageMemorySize (int, int) |
Set / Get the ImageMemorySize. | |
void | SetImageMemorySize (int[2]) |
Set / Get the ImageMemorySize. | |
virtual int * | GetImageMemorySize () |
Set / Get the ImageMemorySize. | |
virtual void | GetImageMemorySize (int data[2]) |
Set / Get the ImageMemorySize. | |
virtual void | SetImageInUseSize (int, int) |
Set / Get the size of the image we are actually using. | |
void | SetImageInUseSize (int[2]) |
Set / Get the size of the image we are actually using. | |
virtual int * | GetImageInUseSize () |
Set / Get the size of the image we are actually using. | |
virtual void | GetImageInUseSize (int data[2]) |
Set / Get the size of the image we are actually using. | |
virtual void | SetImageOrigin (int, int) |
Set / Get the origin of the image. | |
void | SetImageOrigin (int[2]) |
Set / Get the origin of the image. | |
virtual int * | GetImageOrigin () |
Set / Get the origin of the image. | |
virtual void | GetImageOrigin (int data[2]) |
Set / Get the origin of the image. | |
virtual void | SetImageSampleDistance (float) |
Set / Get the ImageSampleDistance that will be used for rendering. | |
virtual float | GetImageSampleDistance () |
Set / Get the ImageSampleDistance that will be used for rendering. | |
virtual void | SetZBufferSize (int, int) |
Set / Get the size of the ZBuffer in pixels. | |
void | SetZBufferSize (int[2]) |
Set / Get the size of the ZBuffer in pixels. | |
virtual int * | GetZBufferSize () |
Set / Get the size of the ZBuffer in pixels. | |
virtual void | GetZBufferSize (int data[2]) |
Set / Get the size of the ZBuffer in pixels. | |
virtual void | SetZBufferOrigin (int, int) |
Set / Get the origin of the ZBuffer. | |
void | SetZBufferOrigin (int[2]) |
Set / Get the origin of the ZBuffer. | |
virtual int * | GetZBufferOrigin () |
Set / Get the origin of the ZBuffer. | |
virtual void | GetZBufferOrigin (int data[2]) |
Set / Get the origin of the ZBuffer. | |
virtual void | SetUseZBuffer (vtkTypeBool) |
The UseZBuffer flag indicates whether the ZBuffer is in use. | |
virtual vtkTypeBool | GetUseZBuffer () |
The UseZBuffer flag indicates whether the ZBuffer is in use. | |
virtual void | UseZBufferOn () |
The UseZBuffer flag indicates whether the ZBuffer is in use. | |
virtual void | UseZBufferOff () |
The UseZBuffer flag indicates whether the ZBuffer is in use. | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkFixedPointRayCastImage * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkFixedPointRayCastImage * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkFixedPointRayCastImage () | |
~vtkFixedPointRayCastImage () override | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
int | ImageViewportSize [2] |
int | ImageMemorySize [2] |
int | ImageInUseSize [2] |
int | ImageOrigin [2] |
float | ImageSampleDistance |
unsigned short * | Image |
int | ZBufferSize [2] |
int | ZBufferMemorySize |
int | ZBufferOrigin [2] |
vtkTypeBool | UseZBuffer |
float * | ZBuffer |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
helper class for a ray cast image
This is a helper class for storing the ray cast image including the underlying data and the size of the image. This class is not intended to be used directly - just as an internal class in the vtkFixedPointVolumeRayCastMapper so that multiple mappers can share the same image. This class also stored the ZBuffer (if necessary due to intermixed geometry). Perhaps this class could be generalized in the future to be used for other ray cast methods other than the fixed point method.
Definition at line 28 of file vtkFixedPointRayCastImage.h.
Definition at line 32 of file vtkFixedPointRayCastImage.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObjectBase.
|
static |
|
protectedvirtual |
vtkFixedPointRayCastImage * vtkFixedPointRayCastImage::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObjectBase.
|
inline |
Get the internal storage for the image.
It is a pointer to unsigned short with four components (RGBA) per pixel. This memory is allocated when the AllocateImage method is called.
Definition at line 40 of file vtkFixedPointRayCastImage.h.
|
virtual |
Set / Get the ImageViewportSize.
This is the size of the whole viewport in pixels.
void vtkFixedPointRayCastImage::SetImageViewportSize | ( | int | [2] | ) |
Set / Get the ImageViewportSize.
This is the size of the whole viewport in pixels.
|
virtual |
Set / Get the ImageViewportSize.
This is the size of the whole viewport in pixels.
|
virtual |
Set / Get the ImageViewportSize.
This is the size of the whole viewport in pixels.
|
virtual |
Set / Get the ImageMemorySize.
This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.
void vtkFixedPointRayCastImage::SetImageMemorySize | ( | int | [2] | ) |
Set / Get the ImageMemorySize.
This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.
|
virtual |
Set / Get the ImageMemorySize.
This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.
|
virtual |
Set / Get the ImageMemorySize.
This is the size in pixels of the Image ivar. This will be a power of two in order to ensure that the texture can be rendered by graphics hardware that requires power of two textures.
|
virtual |
Set / Get the size of the image we are actually using.
As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.
void vtkFixedPointRayCastImage::SetImageInUseSize | ( | int | [2] | ) |
Set / Get the size of the image we are actually using.
As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.
|
virtual |
Set / Get the size of the image we are actually using.
As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.
|
virtual |
Set / Get the size of the image we are actually using.
As long as the memory size is big enough, but not too big, we won't bother deleting and re-allocated, we'll just continue to use the memory size we have. This size will always be equal to or less than the ImageMemorySize.
|
virtual |
Set / Get the origin of the image.
This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.
void vtkFixedPointRayCastImage::SetImageOrigin | ( | int | [2] | ) |
Set / Get the origin of the image.
This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.
|
virtual |
Set / Get the origin of the image.
This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.
|
virtual |
Set / Get the origin of the image.
This is the starting pixel within the whole viewport that our Image starts on. That is, we could be generating just a subregion of the whole viewport due to the fact that our volume occupies only a portion of the viewport. The Image pixels will start from this location.
|
virtual |
Set / Get the ImageSampleDistance that will be used for rendering.
This is a copy of the value stored in the mapper. It is stored here for sharing between all mappers that are participating in the creation of this image.
|
virtual |
Set / Get the ImageSampleDistance that will be used for rendering.
This is a copy of the value stored in the mapper. It is stored here for sharing between all mappers that are participating in the creation of this image.
void vtkFixedPointRayCastImage::AllocateImage | ( | ) |
Call this method once the ImageMemorySize has been set the allocate the image.
If an image already exists, it will be deleted first.
void vtkFixedPointRayCastImage::ClearImage | ( | ) |
Clear the image to (0,0,0,0) for each pixel.
|
virtual |
Set / Get the size of the ZBuffer in pixels.
The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.
void vtkFixedPointRayCastImage::SetZBufferSize | ( | int | [2] | ) |
Set / Get the size of the ZBuffer in pixels.
The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.
|
virtual |
Set / Get the size of the ZBuffer in pixels.
The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.
|
virtual |
Set / Get the size of the ZBuffer in pixels.
The zbuffer will be captured for the region of the screen covered by the ImageInUseSize image. However, due to subsampling, the size of the ImageInUseSize image may be smaller than this ZBuffer image which will be captured at screen resolution.
|
virtual |
Set / Get the origin of the ZBuffer.
This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.
void vtkFixedPointRayCastImage::SetZBufferOrigin | ( | int | [2] | ) |
Set / Get the origin of the ZBuffer.
This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.
|
virtual |
Set / Get the origin of the ZBuffer.
This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.
|
virtual |
Set / Get the origin of the ZBuffer.
This is the distance from the lower left corner of the viewport where the ZBuffer started (multiply the ImageOrigin by the ImageSampleDistance) This is the pixel location on the full resolution viewport where the ZBuffer capture will start. These values are used to convert the (x,y) pixel location within the ImageInUseSize image into a ZBuffer location.
|
virtual |
The UseZBuffer flag indicates whether the ZBuffer is in use.
The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.
|
virtual |
The UseZBuffer flag indicates whether the ZBuffer is in use.
The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.
|
virtual |
The UseZBuffer flag indicates whether the ZBuffer is in use.
The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.
|
virtual |
The UseZBuffer flag indicates whether the ZBuffer is in use.
The ZBuffer is captured and used when IntermixIntersectingGeometry is on in the mapper, and when there are props that have been rendered before the current volume.
float vtkFixedPointRayCastImage::GetZBufferValue | ( | int | x, |
int | y | ||
) |
Get the ZBuffer value corresponding to location (x,y) where (x,y) are indexing into the ImageInUse image.
This must be converted to the zbuffer image coordinates. Nearest neighbor value is returned. If UseZBuffer is off, then 1.0 is always returned.
|
inline |
Get the ZBuffer.
The size of the ZBuffer should be specific with SetZBufferSize, and AllocateZBuffer method should be called before getting the ZBuffer.
Definition at line 161 of file vtkFixedPointRayCastImage.h.
void vtkFixedPointRayCastImage::AllocateZBuffer | ( | ) |
|
protected |
Definition at line 172 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 178 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 184 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 188 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 192 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 195 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 198 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 203 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 207 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 210 of file vtkFixedPointRayCastImage.h.
|
protected |
Definition at line 213 of file vtkFixedPointRayCastImage.h.