VTK  9.4.20241223
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBillboardTextActor3D Class Reference

Renders pixel-aligned text, facing the camera, anchored at a 3D point. More...

#include <vtkBillboardTextActor3D.h>

Inheritance diagram for vtkBillboardTextActor3D:
[legend]
Collaboration diagram for vtkBillboardTextActor3D:
[legend]

Public Types

typedef vtkProp3D Superclass
 
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
 
enum  CoordinateSystems { WORLD = 0 , PHYSICAL = 1 , DEVICE = 2 }
 Specify the coordinate system that this prop is relative to. More...
 
- Public Types inherited from vtkProp
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.
 
vtkBillboardTextActor3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
void UpdateGeometry (vtkViewport *vp)
 Updates the billboard geometry without performing any rendering, to assist GetActors().
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Defers to internal actor.
 
int RenderOpaqueGeometry (vtkViewport *vp) override
 Check/update geometry/texture in opaque pass, since it only happens once.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vp) override
 Just render in translucent pass, since it can execute multiple times (depth peeling, for instance).
 
void ReleaseGraphicsResources (vtkWindow *win) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
double * GetBounds () override
 Return a reference to the Prop3D's composite transform.
 
virtual double * GetAnchorDC ()
 Returns the anchor position in display coordinates, with depth in NDC.
 
virtual void GetAnchorDC (double &, double &, double &)
 
virtual void GetAnchorDC (double[3])
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform.
 
double * GetBounds () override=0
 Return a reference to the Prop3D's composite transform.
 
void SetInput (const char *in)
 The UTF-8 encoded string to display.
 
virtual char * GetInput ()
 The UTF-8 encoded string to display.
 
virtual int * GetDisplayOffset ()
 Can be used to set a fixed offset from the anchor point.
 
virtual void GetDisplayOffset (int &, int &)
 Can be used to set a fixed offset from the anchor point.
 
virtual void GetDisplayOffset (int[2])
 Can be used to set a fixed offset from the anchor point.
 
virtual void SetDisplayOffset (int, int)
 Can be used to set a fixed offset from the anchor point.
 
void SetDisplayOffset (int[2])
 Can be used to set a fixed offset from the anchor point.
 
void SetTextProperty (vtkTextProperty *tprop)
 The vtkTextProperty object that controls the rendered text.
 
virtual vtkTextPropertyGetTextProperty ()
 The vtkTextProperty object that controls the rendered text.
 
virtual void SetForceOpaque (bool opaque)
 Force the actor to render during the opaque or translucent pass.
 
virtual bool GetForceOpaque ()
 Force the actor to render during the opaque or translucent pass.
 
virtual void ForceOpaqueOn ()
 Force the actor to render during the opaque or translucent pass.
 
virtual void ForceOpaqueOff ()
 Force the actor to render during the opaque or translucent pass.
 
virtual void SetForceTranslucent (bool trans)
 Force the actor to render during the opaque or translucent pass.
 
virtual bool GetForceTranslucent ()
 Force the actor to render during the opaque or translucent pass.
 
virtual void ForceTranslucentOn ()
 Force the actor to render during the opaque or translucent pass.
 
virtual void ForceTranslucentOff ()
 Force the actor to render during the opaque or translucent pass.
 
- Public Member Functions inherited from vtkProp3D
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp3D.
 
virtual void SetPosition (double pos[3])
 
virtual double * GetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
void SetScale (double s)
 Method to set the scale isotropically.
 
virtual void SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld)
 Set the position, scale, orientation from a provided model to world matrix.
 
double * GetCenter ()
 Get the center of the bounding box in world coordinates.
 
double * GetXRange ()
 Get the Prop3D's x range in world coordinates.
 
double * GetYRange ()
 Get the Prop3D's y range in world coordinates.
 
double * GetZRange ()
 Get the Prop3D's z range in world coordinates.
 
double GetLength ()
 Get the length of the diagonal of the bounding box.
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule.
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule.
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule.
 
void RotateWXYZ (double w, double x, double y, double z)
 Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments.
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D.
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D.
 
double * GetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D.
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation.
 
void AddOrientation (double orentation[3])
 Add to the current orientation.
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified.
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths.
 
vtkMTimeType GetMTime () override
 Get the vtkProp3D's mtime.
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform.
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates.
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D.
 
virtual void SetOrigin (const double pos[3])
 Set/Get the origin of the Prop3D.
 
virtual double * GetOrigin ()
 Set/Get the origin of the Prop3D.
 
virtual void GetOrigin (double data[3])
 Set/Get the origin of the Prop3D.
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor.
 
virtual void SetScale (double scale[3])
 Set/Get the scale of the actor.
 
virtual double * GetScale ()
 Set/Get the scale of the actor.
 
virtual void GetScale (double data[3])
 Set/Get the scale of the actor.
 
void SetUserTransform (vtkLinearTransform *transform)
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
 
virtual vtkLinearTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform.
 
vtkMatrix4x4GetUserMatrix ()
 The UserMatrix can be used in place of UserTransform.
 
virtual void GetMatrix (vtkMatrix4x4 *result)
 Return a reference to the Prop3D's 4x4 composite matrix.
 
virtual void GetMatrix (double result[16])
 Return a reference to the Prop3D's 4x4 composite matrix.
 
virtual void GetModelToWorldMatrix (vtkMatrix4x4 *result)
 Return a reference to the Prop3D's Model to World matrix.
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform.
 
double * GetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
 
void GetOrientation (double orentation[3])
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
 
virtual void ComputeMatrix ()
 Generate the matrix based on ivars.
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4.
 
virtual vtkTypeBool GetIsIdentity ()
 Is the matrix for this actor identity.
 
void SetCoordinateSystemRenderer (vtkRenderer *ren)
 Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.
 
vtkRendererGetCoordinateSystemRenderer ()
 Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.
 
virtual void SetCoordinateSystemDevice (int)
 Specify the device to be used when the coordinate system is set to DEVICE.
 
virtual int GetCoordinateSystemDevice ()
 Specify the device to be used when the coordinate system is set to DEVICE.
 
void SetCoordinateSystemToWorld ()
 Specify the coordinate system that this prop is relative to.
 
void SetCoordinateSystemToPhysical ()
 Specify the coordinate system that this prop is relative to.
 
void SetCoordinateSystemToDevice ()
 Specify the coordinate system that this prop is relative to.
 
void SetCoordinateSystem (CoordinateSystems val)
 Specify the coordinate system that this prop is relative to.
 
virtual CoordinateSystems GetCoordinateSystem ()
 Specify the coordinate system that this prop is relative to.
 
const char * GetCoordinateSystemAsString ()
 Specify the coordinate system that this prop is relative to.
 
- Public Member Functions inherited from vtkProp
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently.
 
virtual double * GetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp.
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys.
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys.
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp.
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp.
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable.
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable.
 
virtual void PickableOn ()
 Set/Get the pickable instance variable.
 
virtual void PickableOff ()
 Set/Get the pickable instance variable.
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable.
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable.
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys.
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys.
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers.
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,.
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property.
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property.
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 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.
 
vtkCommandGetCommand (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.
 
- Public Member Functions inherited from vtkObjectBase
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 vtkBillboardTextActor3DNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBillboardTextActor3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 Public Member Functions inherited from vtkObjectBase
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkBillboardTextActor3D ()
 
 ~vtkBillboardTextActor3D () override
 
bool InputIsValid ()
 
void UpdateInternals (vtkRenderer *ren)
 
bool TextureIsStale (vtkRenderer *ren)
 
void GenerateTexture (vtkRenderer *ren)
 
bool QuadIsStale (vtkRenderer *ren)
 
void GenerateQuad (vtkRenderer *ren)
 
void Invalidate ()
 
bool IsValid ()
 
void PreRender ()
 
- Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 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.
 
- Protected Member Functions inherited from vtkObjectBase
 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

char * Input
 
vtkTextPropertyTextProperty
 
int DisplayOffset [2]
 
int RenderedDPI
 
vtkTimeStamp InputMTime
 
vtkSmartPointer< vtkRendererRenderedRenderer
 
vtkNew< vtkTextRendererTextRenderer
 
vtkNew< vtkImageDataImage
 
vtkNew< vtkTextureTexture
 
vtkNew< vtkPolyDataQuad
 
vtkNew< vtkPolyDataMapperQuadMapper
 
vtkNew< vtkActorQuadActor
 
double AnchorDC [3]
 
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
 
vtkMatrix4x4UserMatrix
 
vtkMatrix4x4Matrix
 
vtkTimeStamp MatrixMTime
 
double Origin [3]
 
double Position [3]
 
double Orientation [3]
 
double Scale [3]
 
double Center [3]
 
vtkTransformTransform
 
double Bounds [6]
 
vtkProp3DCachedProp3D
 
vtkTypeBool IsIdentity
 
int CoordinateSystemDevice
 
CoordinateSystems CoordinateSystem = WORLD
 
vtkWeakPointer< vtkRendererCoordinateSystemRenderer
 
vtkNew< vtkMatrix4x4TempMatrix4x4
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Renders pixel-aligned text, facing the camera, anchored at a 3D point.

Online Examples:

Tests:
vtkBillboardTextActor3D (Tests)

Definition at line 48 of file vtkBillboardTextActor3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkBillboardTextActor3D.h.

Constructor & Destructor Documentation

◆ vtkBillboardTextActor3D()

vtkBillboardTextActor3D::vtkBillboardTextActor3D ( )
protected

◆ ~vtkBillboardTextActor3D()

vtkBillboardTextActor3D::~vtkBillboardTextActor3D ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBillboardTextActor3D * vtkBillboardTextActor3D::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkBillboardTextActor3D::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkBillboardTextActor3D::IsA ( const char *  name)
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 vtkProp3D.

Reimplemented in vtkOpenGLBillboardTextActor3D.

◆ SafeDownCast()

static vtkBillboardTextActor3D * vtkBillboardTextActor3D::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBillboardTextActor3D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp3D.

Reimplemented in vtkOpenGLBillboardTextActor3D.

◆ NewInstance()

vtkBillboardTextActor3D * vtkBillboardTextActor3D::NewInstance ( ) const

◆ PrintSelf()

void vtkBillboardTextActor3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

Reimplemented in vtkOpenGLBillboardTextActor3D.

◆ GetActors()

void vtkBillboardTextActor3D::GetActors ( vtkPropCollection )
overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process. In case the viewport is not a consumer of this prop: call UpdateGeometry() first for updated viewport-specific billboard geometry.

Reimplemented from vtkProp.

◆ UpdateGeometry()

void vtkBillboardTextActor3D::UpdateGeometry ( vtkViewport vp)

Updates the billboard geometry without performing any rendering, to assist GetActors().

◆ SetInput()

void vtkBillboardTextActor3D::SetInput ( const char *  in)

The UTF-8 encoded string to display.

◆ GetInput()

virtual char * vtkBillboardTextActor3D::GetInput ( )
virtual

The UTF-8 encoded string to display.

◆ GetDisplayOffset() [1/3]

virtual int * vtkBillboardTextActor3D::GetDisplayOffset ( )
virtual

Can be used to set a fixed offset from the anchor point.

Use display coordinates.

◆ GetDisplayOffset() [2/3]

virtual void vtkBillboardTextActor3D::GetDisplayOffset ( int &  ,
int &   
)
virtual

Can be used to set a fixed offset from the anchor point.

Use display coordinates.

◆ GetDisplayOffset() [3/3]

virtual void vtkBillboardTextActor3D::GetDisplayOffset ( int  [2])
virtual

Can be used to set a fixed offset from the anchor point.

Use display coordinates.

◆ SetDisplayOffset() [1/2]

virtual void vtkBillboardTextActor3D::SetDisplayOffset ( int  ,
int   
)
virtual

Can be used to set a fixed offset from the anchor point.

Use display coordinates.

◆ SetDisplayOffset() [2/2]

void vtkBillboardTextActor3D::SetDisplayOffset ( int  [2])

Can be used to set a fixed offset from the anchor point.

Use display coordinates.

◆ SetTextProperty()

void vtkBillboardTextActor3D::SetTextProperty ( vtkTextProperty tprop)

The vtkTextProperty object that controls the rendered text.

◆ GetTextProperty()

virtual vtkTextProperty * vtkBillboardTextActor3D::GetTextProperty ( )
virtual

The vtkTextProperty object that controls the rendered text.

◆ SetForceOpaque()

virtual void vtkBillboardTextActor3D::SetForceOpaque ( bool  opaque)
virtual

Force the actor to render during the opaque or translucent pass.

◆ GetForceOpaque()

virtual bool vtkBillboardTextActor3D::GetForceOpaque ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ ForceOpaqueOn()

virtual void vtkBillboardTextActor3D::ForceOpaqueOn ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ ForceOpaqueOff()

virtual void vtkBillboardTextActor3D::ForceOpaqueOff ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ SetForceTranslucent()

virtual void vtkBillboardTextActor3D::SetForceTranslucent ( bool  trans)
virtual

Force the actor to render during the opaque or translucent pass.

◆ GetForceTranslucent()

virtual bool vtkBillboardTextActor3D::GetForceTranslucent ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ ForceTranslucentOn()

virtual void vtkBillboardTextActor3D::ForceTranslucentOn ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ ForceTranslucentOff()

virtual void vtkBillboardTextActor3D::ForceTranslucentOff ( )
virtual

Force the actor to render during the opaque or translucent pass.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkBillboardTextActor3D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Defers to internal actor.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkBillboardTextActor3D::RenderOpaqueGeometry ( vtkViewport vp)
overridevirtual

Check/update geometry/texture in opaque pass, since it only happens once.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkBillboardTextActor3D::RenderTranslucentPolygonalGeometry ( vtkViewport vp)
overridevirtual

Just render in translucent pass, since it can execute multiple times (depth peeling, for instance).

Reimplemented from vtkProp.

Reimplemented in vtkOpenGLBillboardTextActor3D.

◆ ReleaseGraphicsResources()

void vtkBillboardTextActor3D::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

◆ GetBounds() [1/3]

double * vtkBillboardTextActor3D::GetBounds ( )
overridevirtual

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Implements vtkProp3D.

◆ GetAnchorDC() [1/3]

virtual double * vtkBillboardTextActor3D::GetAnchorDC ( )
virtual

Returns the anchor position in display coordinates, with depth in NDC.

Valid after calling RenderOpaqueGeometry.

◆ GetAnchorDC() [2/3]

virtual void vtkBillboardTextActor3D::GetAnchorDC ( double &  ,
double &  ,
double &   
)
virtual

◆ GetAnchorDC() [3/3]

virtual void vtkBillboardTextActor3D::GetAnchorDC ( double  [3])
virtual

◆ InputIsValid()

bool vtkBillboardTextActor3D::InputIsValid ( )
protected

◆ UpdateInternals()

void vtkBillboardTextActor3D::UpdateInternals ( vtkRenderer ren)
protected

◆ TextureIsStale()

bool vtkBillboardTextActor3D::TextureIsStale ( vtkRenderer ren)
protected

◆ GenerateTexture()

void vtkBillboardTextActor3D::GenerateTexture ( vtkRenderer ren)
protected

◆ QuadIsStale()

bool vtkBillboardTextActor3D::QuadIsStale ( vtkRenderer ren)
protected

◆ GenerateQuad()

void vtkBillboardTextActor3D::GenerateQuad ( vtkRenderer ren)
protected

◆ Invalidate()

void vtkBillboardTextActor3D::Invalidate ( )
protected

◆ IsValid()

bool vtkBillboardTextActor3D::IsValid ( )
protected

◆ PreRender()

void vtkBillboardTextActor3D::PreRender ( )
protected

◆ GetBounds() [2/3]

void vtkProp3D::GetBounds ( double  bounds[6])

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

◆ GetBounds() [3/3]

double * vtkProp3D::GetBounds ( )
overridevirtual

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Implements vtkProp3D.

Member Data Documentation

◆ Input

char* vtkBillboardTextActor3D::Input
protected

Definition at line 158 of file vtkBillboardTextActor3D.h.

◆ TextProperty

vtkTextProperty* vtkBillboardTextActor3D::TextProperty
protected

Definition at line 159 of file vtkBillboardTextActor3D.h.

◆ DisplayOffset

int vtkBillboardTextActor3D::DisplayOffset[2]
protected

Definition at line 162 of file vtkBillboardTextActor3D.h.

◆ RenderedDPI

int vtkBillboardTextActor3D::RenderedDPI
protected

Definition at line 165 of file vtkBillboardTextActor3D.h.

◆ InputMTime

vtkTimeStamp vtkBillboardTextActor3D::InputMTime
protected

Definition at line 166 of file vtkBillboardTextActor3D.h.

◆ RenderedRenderer

vtkSmartPointer<vtkRenderer> vtkBillboardTextActor3D::RenderedRenderer
protected

Definition at line 169 of file vtkBillboardTextActor3D.h.

◆ TextRenderer

vtkNew<vtkTextRenderer> vtkBillboardTextActor3D::TextRenderer
protected

Definition at line 172 of file vtkBillboardTextActor3D.h.

◆ Image

vtkNew<vtkImageData> vtkBillboardTextActor3D::Image
protected

Definition at line 173 of file vtkBillboardTextActor3D.h.

◆ Texture

vtkNew<vtkTexture> vtkBillboardTextActor3D::Texture
protected

Definition at line 174 of file vtkBillboardTextActor3D.h.

◆ Quad

vtkNew<vtkPolyData> vtkBillboardTextActor3D::Quad
protected

Definition at line 175 of file vtkBillboardTextActor3D.h.

◆ QuadMapper

vtkNew<vtkPolyDataMapper> vtkBillboardTextActor3D::QuadMapper
protected

Definition at line 176 of file vtkBillboardTextActor3D.h.

◆ QuadActor

vtkNew<vtkActor> vtkBillboardTextActor3D::QuadActor
protected

Definition at line 177 of file vtkBillboardTextActor3D.h.

◆ AnchorDC

double vtkBillboardTextActor3D::AnchorDC[3]
protected

Definition at line 181 of file vtkBillboardTextActor3D.h.


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