VTK  9.3.20240329
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProp3DAxisFollower Class Reference

a subclass of vtkProp3DFollower that ensures that data is always parallel to the axis defined by a vtkAxisActor. More...

#include <vtkProp3DAxisFollower.h>

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

Public Member Functions

void ComputeMatrix () override
 Generate the matrix based on ivars. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of a follower. More...
 
virtual void SetViewport (vtkViewport *viewport)
 
virtual vtkViewportGetViewport ()
 
virtual void SetAxis (vtkAxisActor *)
 Set axis that needs to be followed. More...
 
virtual vtkAxisActorGetAxis ()
 Set axis that needs to be followed. More...
 
virtual void SetAutoCenter (vtkTypeBool)
 Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds. More...
 
virtual vtkTypeBool GetAutoCenter ()
 Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds. More...
 
virtual void AutoCenterOn ()
 Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds. More...
 
virtual void AutoCenterOff ()
 Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds. More...
 
virtual void SetEnableDistanceLOD (int)
 Enable / disable use of distance based LOD. More...
 
virtual int GetEnableDistanceLOD ()
 Enable / disable use of distance based LOD. More...
 
virtual void SetDistanceLODThreshold (double)
 Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible. More...
 
virtual double GetDistanceLODThreshold ()
 Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible. More...
 
virtual void SetEnableViewAngleLOD (int)
 Enable / disable use of view angle based LOD. More...
 
virtual int GetEnableViewAngleLOD ()
 Enable / disable use of view angle based LOD. More...
 
virtual void SetViewAngleLODThreshold (double)
 Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visible. More...
 
virtual double GetViewAngleLODThreshold ()
 Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visible. More...
 
double GetScreenOffset ()
 Set/Get the desired screen vertical offset from the axis. More...
 
void SetScreenOffset (double offset)
 Set/Get the desired screen vertical offset from the axis. More...
 
virtual void SetScreenOffsetVector (double, double)
 Set/Get the desired screen offset from the axis. More...
 
void SetScreenOffsetVector (double[2])
 Set/Get the desired screen offset from the axis. More...
 
virtual double * GetScreenOffsetVector ()
 Set/Get the desired screen offset from the axis. More...
 
virtual void GetScreenOffsetVector (double &, double &)
 Set/Get the desired screen offset from the axis. More...
 
virtual void GetScreenOffsetVector (double[2])
 Set/Get the desired screen offset from the axis. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
int RenderVolumetricGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
- Public Member Functions inherited from vtkProp3DFollower
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources associated with this vtkProp3DFollower. More...
 
void ComputeMatrix () override
 Generate the matrix based on ivars. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of a follower. More...
 
double * GetBounds () override
 Return the bounds of this vtkProp3D. More...
 
virtual void SetProp3D (vtkProp3D *prop)
 Set/Get the vtkProp3D to control (i.e., face the camera). More...
 
virtual vtkProp3DGetProp3D ()
 Set/Get the vtkProp3D to control (i.e., face the camera). More...
 
virtual void SetCamera (vtkCamera *)
 Set/Get the camera to follow. More...
 
virtual vtkCameraGetCamera ()
 Set/Get the camera to follow. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
int RenderVolumetricGeometry (vtkViewport *viewport) override
 This causes the actor to be rendered. More...
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths. More...
 
vtkAssemblyPathGetNextPath () override
 Overload vtkProp's method for setting up assembly paths. More...
 
vtkProp3DFollowerNewInstance () const
 Standard VTK methods for type and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK methods for type and printing. More...
 
- Public Member Functions inherited from vtkProp3D
vtkProp3DNewInstance () const
 
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. More...
 
virtual void SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld)
 Set the position, scale, orientation from a provided model to world matrix. More...
 
double * GetCenter ()
 Get the center of the bounding box in world coordinates. More...
 
double * GetXRange ()
 Get the Prop3D's x range in world coordinates. More...
 
double * GetYRange ()
 Get the Prop3D's y range in world coordinates. More...
 
double * GetZRange ()
 Get the Prop3D's z range in world coordinates. More...
 
double GetLength ()
 Get the length of the diagonal of the bounding box. More...
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule. More...
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule. More...
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule. More...
 
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. More...
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D. More...
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D. More...
 
double * GetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D. More...
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation. More...
 
void AddOrientation (double orentation[3])
 Add to the current orientation. More...
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. More...
 
vtkMTimeType GetMTime () override
 Get the vtkProp3D's mtime. More...
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform. More...
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates. More...
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D. More...
 
virtual void SetOrigin (const double pos[3])
 Set/Get the origin of the Prop3D. More...
 
virtual double * GetOrigin ()
 Set/Get the origin of the Prop3D. More...
 
virtual void GetOrigin (double data[3])
 Set/Get the origin of the Prop3D. More...
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor. More...
 
virtual void SetScale (double scale[3])
 Set/Get the scale of the actor. More...
 
virtual double * GetScale ()
 Set/Get the scale of the actor. More...
 
virtual void GetScale (double data[3])
 Set/Get the scale of the actor. More...
 
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. More...
 
virtual vtkLinearTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform. More...
 
vtkMatrix4x4GetUserMatrix ()
 The UserMatrix can be used in place of UserTransform. More...
 
virtual void GetMatrix (vtkMatrix4x4 *result)
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetMatrix (double result[16])
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetModelToWorldMatrix (vtkMatrix4x4 *result)
 Return a reference to the Prop3D's Model to World matrix. More...
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform. More...
 
double * GetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
void GetOrientation (double orentation[3])
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4. More...
 
virtual vtkTypeBool GetIsIdentity ()
 Is the matrix for this actor identity. More...
 
void SetCoordinateSystemRenderer (vtkRenderer *ren)
 Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE. More...
 
vtkRendererGetCoordinateSystemRenderer ()
 Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE. More...
 
virtual void SetCoordinateSystemDevice (int)
 Specify the device to be used when the coordinate system is set to DEVICE. More...
 
virtual int GetCoordinateSystemDevice ()
 Specify the device to be used when the coordinate system is set to DEVICE. More...
 
void SetCoordinateSystemToWorld ()
 Specify the coordinate system that this prop is relative to. More...
 
void SetCoordinateSystemToPhysical ()
 Specify the coordinate system that this prop is relative to. More...
 
void SetCoordinateSystemToDevice ()
 Specify the coordinate system that this prop is relative to. More...
 
void SetCoordinateSystem (CoordinateSystems val)
 Specify the coordinate system that this prop is relative to. More...
 
virtual CoordinateSystems GetCoordinateSystem ()
 Specify the coordinate system that this prop is relative to. More...
 
const char * GetCoordinateSystemAsString ()
 Specify the coordinate system that this prop is relative to. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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(). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkProp3DAxisFollowerNew ()
 Creates a follower with no camera set. More...
 
static double AutoScale (vtkViewport *viewport, vtkCamera *camera, double screenSize, double position[3])
 Calculate scale factor to maintain same size of a object on the screen. More...
 
- Static Public Member Functions inherited from vtkProp3DFollower
static vtkProp3DFollowerNew ()
 Creates a follower with no camera set. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK methods for type and printing. More...
 
static vtkProp3DFollowerSafeDownCast (vtkObjectBase *o)
 Standard VTK methods for type and printing. More...
 
- 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. More...
 
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. More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

 vtkProp3DAxisFollower ()
 
 ~vtkProp3DAxisFollower () override
 
void CalculateOrthogonalVectors (double Rx[3], double Ry[3], double Rz[3], vtkAxisActor *axis1, double *dop, vtkViewport *ren)
 
void ComputeRotationAndTranlation (vtkViewport *ren, double translation[3], double Rx[3], double Ry[3], double Rz[3], vtkAxisActor *axis)
 
void ComputerAutoCenterTranslation (const double &autoScaleFactor, double translation[3])
 
int TestDistanceVisibility ()
 
void ExecuteViewAngleVisibility (double normal[3])
 
bool IsTextUpsideDown (double *a, double *b)
 
- Protected Member Functions inherited from vtkProp3DFollower
 vtkProp3DFollower ()
 
 ~vtkProp3DFollower () override
 
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool AutoCenter
 
int EnableDistanceLOD
 
double DistanceLODThreshold
 
int EnableViewAngleLOD
 
double ViewAngleLODThreshold
 
double ScreenOffsetVector [2]
 
vtkWeakPointer< vtkAxisActorAxis
 
vtkWeakPointer< vtkViewportViewport
 
- Protected Attributes inherited from vtkProp3DFollower
vtkCameraCamera
 
vtkProp3DDevice
 
vtkMatrix4x4InternalMatrix
 
- 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
 
typedef vtkProp3DFollower Superclass
 Standard VTK methods for type and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK methods for type and printing. More...
 
static vtkProp3DAxisFollowerSafeDownCast (vtkObjectBase *o)
 Standard VTK methods for type and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK methods for type and printing. More...
 
vtkProp3DAxisFollowerNewInstance () const
 Standard VTK methods for type and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK methods for type and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK methods for type and printing. More...
 

Additional Inherited Members

- Public Types inherited from vtkProp3DFollower
typedef vtkProp3D Superclass
 Standard VTK methods for type and printing. More...
 
- 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
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

a subclass of vtkProp3DFollower that ensures that data is always parallel to the axis defined by a vtkAxisActor.

vtkProp3DAxisFollower is a subclass of vtkProp3DFollower that always follows its specified axis. More specifically it will not change its position or scale, but it will continually update its orientation so that it is aligned with the axis and facing at angle to the camera to provide maximum visibility. This is typically used for text labels for 3d plots.

See also
vtkFollower vtkAxisFollower vtkProp3DFollower

Definition at line 29 of file vtkProp3DAxisFollower.h.

Member Typedef Documentation

◆ Superclass

Standard VTK methods for type and printing.

Definition at line 41 of file vtkProp3DAxisFollower.h.

Constructor & Destructor Documentation

◆ vtkProp3DAxisFollower()

vtkProp3DAxisFollower::vtkProp3DAxisFollower ( )
protected

◆ ~vtkProp3DAxisFollower()

vtkProp3DAxisFollower::~vtkProp3DAxisFollower ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkProp3DAxisFollower* vtkProp3DAxisFollower::New ( )
static

Creates a follower with no camera set.

◆ IsTypeOf()

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

Standard VTK methods for type and printing.

◆ IsA()

virtual vtkTypeBool vtkProp3DAxisFollower::IsA ( const char *  type)
virtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3DFollower.

◆ SafeDownCast()

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

Standard VTK methods for type and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProp3DAxisFollower::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK methods for type and printing.

Reimplemented from vtkProp3DFollower.

◆ NewInstance()

vtkProp3DAxisFollower* vtkProp3DAxisFollower::NewInstance ( ) const

Standard VTK methods for type and printing.

◆ PrintSelf()

void vtkProp3DAxisFollower::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard VTK methods for type and printing.

Reimplemented from vtkObject.

◆ SetAxis()

virtual void vtkProp3DAxisFollower::SetAxis ( vtkAxisActor )
virtual

Set axis that needs to be followed.

◆ GetAxis()

virtual vtkAxisActor* vtkProp3DAxisFollower::GetAxis ( )
virtual

Set axis that needs to be followed.

◆ SetAutoCenter()

virtual void vtkProp3DAxisFollower::SetAutoCenter ( vtkTypeBool  )
virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

◆ GetAutoCenter()

virtual vtkTypeBool vtkProp3DAxisFollower::GetAutoCenter ( )
virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

◆ AutoCenterOn()

virtual void vtkProp3DAxisFollower::AutoCenterOn ( )
virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

◆ AutoCenterOff()

virtual void vtkProp3DAxisFollower::AutoCenterOff ( )
virtual

Set/Get state of auto center mode where additional translation will be added to make sure the underlying geometry has its pivot point at the center of its bounds.

◆ SetEnableDistanceLOD()

virtual void vtkProp3DAxisFollower::SetEnableDistanceLOD ( int  )
virtual

Enable / disable use of distance based LOD.

If enabled the actor will not be visible at a certain distance from the camera. Default is false.

◆ GetEnableDistanceLOD()

virtual int vtkProp3DAxisFollower::GetEnableDistanceLOD ( )
virtual

Enable / disable use of distance based LOD.

If enabled the actor will not be visible at a certain distance from the camera. Default is false.

◆ SetDistanceLODThreshold()

virtual void vtkProp3DAxisFollower::SetDistanceLODThreshold ( double  )
virtual

Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible.

Default is 0.80.

◆ GetDistanceLODThreshold()

virtual double vtkProp3DAxisFollower::GetDistanceLODThreshold ( )
virtual

Set distance LOD threshold (0.0 - 1.0).This determines at what fraction of camera far clip range, actor is not visible.

Default is 0.80.

◆ SetEnableViewAngleLOD()

virtual void vtkProp3DAxisFollower::SetEnableViewAngleLOD ( int  )
virtual

Enable / disable use of view angle based LOD.

If enabled the actor will not be visible at a certain view angle. Default is true.

◆ GetEnableViewAngleLOD()

virtual int vtkProp3DAxisFollower::GetEnableViewAngleLOD ( )
virtual

Enable / disable use of view angle based LOD.

If enabled the actor will not be visible at a certain view angle. Default is true.

◆ SetViewAngleLODThreshold()

virtual void vtkProp3DAxisFollower::SetViewAngleLODThreshold ( double  )
virtual

Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visible.

Default is 0.34.

◆ GetViewAngleLODThreshold()

virtual double vtkProp3DAxisFollower::GetViewAngleLODThreshold ( )
virtual

Set view angle LOD threshold (0.0 - 1.0).This determines at what view angle to geometry will make the geometry not visible.

Default is 0.34.

◆ GetScreenOffset()

double vtkProp3DAxisFollower::GetScreenOffset ( )

Set/Get the desired screen vertical offset from the axis.

Convenience method, using a zero horizontal offset

◆ SetScreenOffset()

void vtkProp3DAxisFollower::SetScreenOffset ( double  offset)

Set/Get the desired screen vertical offset from the axis.

Convenience method, using a zero horizontal offset

◆ SetScreenOffsetVector() [1/2]

virtual void vtkProp3DAxisFollower::SetScreenOffsetVector ( double  ,
double   
)
virtual

Set/Get the desired screen offset from the axis.

◆ SetScreenOffsetVector() [2/2]

void vtkProp3DAxisFollower::SetScreenOffsetVector ( double  [2])

Set/Get the desired screen offset from the axis.

◆ GetScreenOffsetVector() [1/3]

virtual double* vtkProp3DAxisFollower::GetScreenOffsetVector ( )
virtual

Set/Get the desired screen offset from the axis.

◆ GetScreenOffsetVector() [2/3]

virtual void vtkProp3DAxisFollower::GetScreenOffsetVector ( double &  ,
double &   
)
virtual

Set/Get the desired screen offset from the axis.

◆ GetScreenOffsetVector() [3/3]

virtual void vtkProp3DAxisFollower::GetScreenOffsetVector ( double  [2])
virtual

Set/Get the desired screen offset from the axis.

◆ ComputeMatrix()

void vtkProp3DAxisFollower::ComputeMatrix ( )
overridevirtual

Generate the matrix based on ivars.

This method overloads its superclasses ComputeMatrix() method due to the special vtkProp3DAxisFollower matrix operations.

Reimplemented from vtkProp3D.

◆ ShallowCopy()

void vtkProp3DAxisFollower::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of a follower.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

◆ AutoScale()

static double vtkProp3DAxisFollower::AutoScale ( vtkViewport viewport,
vtkCamera camera,
double  screenSize,
double  position[3] 
)
static

Calculate scale factor to maintain same size of a object on the screen.

◆ RenderOpaqueGeometry()

int vtkProp3DAxisFollower::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

This causes the actor to be rendered.

It in turn will render the actor's property, texture map and then mapper. If a property hasn't been assigned, then the actor will create one automatically.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkProp3DAxisFollower::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

This causes the actor to be rendered.

It in turn will render the actor's property, texture map and then mapper. If a property hasn't been assigned, then the actor will create one automatically.

Reimplemented from vtkProp.

◆ RenderVolumetricGeometry()

int vtkProp3DAxisFollower::RenderVolumetricGeometry ( vtkViewport viewport)
overridevirtual

This causes the actor to be rendered.

It in turn will render the actor's property, texture map and then mapper. If a property hasn't been assigned, then the actor will create one automatically.

Reimplemented from vtkProp.

◆ SetViewport()

virtual void vtkProp3DAxisFollower::SetViewport ( vtkViewport viewport)
virtual

◆ GetViewport()

virtual vtkViewport* vtkProp3DAxisFollower::GetViewport ( )
virtual

◆ CalculateOrthogonalVectors()

void vtkProp3DAxisFollower::CalculateOrthogonalVectors ( double  Rx[3],
double  Ry[3],
double  Rz[3],
vtkAxisActor axis1,
double *  dop,
vtkViewport ren 
)
protected

◆ ComputeRotationAndTranlation()

void vtkProp3DAxisFollower::ComputeRotationAndTranlation ( vtkViewport ren,
double  translation[3],
double  Rx[3],
double  Ry[3],
double  Rz[3],
vtkAxisActor axis 
)
protected

◆ ComputerAutoCenterTranslation()

void vtkProp3DAxisFollower::ComputerAutoCenterTranslation ( const double &  autoScaleFactor,
double  translation[3] 
)
protected

◆ TestDistanceVisibility()

int vtkProp3DAxisFollower::TestDistanceVisibility ( )
protected

◆ ExecuteViewAngleVisibility()

void vtkProp3DAxisFollower::ExecuteViewAngleVisibility ( double  normal[3])
protected

◆ IsTextUpsideDown()

bool vtkProp3DAxisFollower::IsTextUpsideDown ( double *  a,
double *  b 
)
protected

Member Data Documentation

◆ AutoCenter

vtkTypeBool vtkProp3DAxisFollower::AutoCenter
protected

Definition at line 171 of file vtkProp3DAxisFollower.h.

◆ EnableDistanceLOD

int vtkProp3DAxisFollower::EnableDistanceLOD
protected

Definition at line 173 of file vtkProp3DAxisFollower.h.

◆ DistanceLODThreshold

double vtkProp3DAxisFollower::DistanceLODThreshold
protected

Definition at line 174 of file vtkProp3DAxisFollower.h.

◆ EnableViewAngleLOD

int vtkProp3DAxisFollower::EnableViewAngleLOD
protected

Definition at line 176 of file vtkProp3DAxisFollower.h.

◆ ViewAngleLODThreshold

double vtkProp3DAxisFollower::ViewAngleLODThreshold
protected

Definition at line 177 of file vtkProp3DAxisFollower.h.

◆ ScreenOffsetVector

double vtkProp3DAxisFollower::ScreenOffsetVector[2]
protected

Definition at line 179 of file vtkProp3DAxisFollower.h.

◆ Axis

vtkWeakPointer<vtkAxisActor> vtkProp3DAxisFollower::Axis
protected

Definition at line 181 of file vtkProp3DAxisFollower.h.

◆ Viewport

vtkWeakPointer<vtkViewport> vtkProp3DAxisFollower::Viewport
protected

Definition at line 182 of file vtkProp3DAxisFollower.h.


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