nightly/html/TestAxisActorInternal_8h_source.html

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen

// SPDX-License-Identifier: BSD-3-Clause

#ifndef TestAxisActorInternal_h

#define TestAxisActorInternal_h


#include "vtkAxisActor.h"

#include "vtkCamera.h"

#include "vtkNew.h"

#include "vtkPolyDataMapper.h"

#include "vtkProperty.h"

#include "vtkRenderWindow.h"

#include "vtkRenderWindowInteractor.h"

#include "vtkRenderer.h"

#include "vtkStringArray.h"

#include "vtkTextProperty.h"


namespace

{

// ----------------------------------------------------------------------------

inline void InitializeAxis(vtkAxisActor* axis)

{

  axis->SetPoint1(0, 0, 0);

  axis->SetExponent("+00");

  axis->SetExponentVisibility(true);

  axis->SetTitleScale(0.8);

  axis->SetLabelScale(0.5);


  vtkNew<vtkStringArray> labels;

  labels->SetNumberOfTuples(6);

  labels->SetValue(0, "0");

  labels->SetValue(1, "2");

  labels->SetValue(2, "4");

  labels->SetValue(3, "6");

  labels->SetValue(4, "8");

  labels->SetValue(5, "10");

  axis->SetLabels(labels);


  vtkNew<vtkCamera> camera;

  axis->SetCamera(camera);

}


// ----------------------------------------------------------------------------

inline void InitializeXAxis(vtkAxisActor* axis)

{

  ::InitializeAxis(axis);

  axis->SetPoint2(10, 0, 0);

  axis->SetTitle("X Axis");

  axis->SetBounds(0, 10, 0, 0, 0, 0);

  axis->SetTickLocationToBoth();

  axis->SetAxisTypeToX();

  axis->SetRange(0, 10);

  axis->SetLabelOffset(5);

  axis->SetDeltaRangeMajor(2);

  axis->SetDeltaRangeMinor(0.5);

  axis->SetExponentOffset(30);

  axis->SetTitleOffset(0, 30);


  vtkNew<vtkTextProperty> textProp1;

  textProp1->SetColor(0., 0., 1.);

  textProp1->SetOpacity(0.9);

  textProp1->SetFontSize(24);

  axis->SetTitleTextProperty(textProp1);


  vtkNew<vtkTextProperty> textProp2;

  textProp2->SetColor(1., 0., 0.);

  textProp2->SetOpacity(0.6);

  textProp2->SetFontSize(18);

  axis->SetLabelTextProperty(textProp2);


  vtkNew<vtkProperty> prop1;

  prop1->SetColor(1., 0., 1.);

  axis->SetAxisMainLineProperty(prop1);


  vtkNew<vtkProperty> prop2;

  prop2->SetColor(1., 1., 0.);

  axis->SetAxisMajorTicksProperty(prop2);


  vtkNew<vtkProperty> prop3;

  prop3->SetColor(0., 1., 1.);

  axis->SetAxisMinorTicksProperty(prop3);

}


// ----------------------------------------------------------------------------

inline void InitializeYAxis(vtkAxisActor* axis)

{

  ::InitializeAxis(axis);

  axis->SetPoint2(0, 10, 0);

  axis->SetTitle("Y Axis");

  axis->SetBounds(0, 0, 0, 10, 0, 0);

  axis->SetTickLocationToInside();

  axis->SetAxisTypeToY();

  axis->SetRange(0.1, 4000);

  axis->SetMajorRangeStart(0.1);

  axis->SetMinorRangeStart(0.1);

  axis->SetMinorTicksVisible(true);

  axis->SetTitleAlignLocation(vtkAxisActor::VTK_ALIGN_TOP);

  axis->SetTitleOffset(0, 3);

  axis->SetExponentLocation(vtkAxisActor::VTK_ALIGN_TOP);

  axis->SetExponentOffset(20);

  axis->SetLog(true);


  axis->GetCamera()->SetViewUp(1, 0, 0);


  vtkNew<vtkTextProperty> textProp2;

  textProp2->SetColor(1., 0., 0.);

  textProp2->SetOpacity(0.6);

  axis->SetTitleTextProperty(textProp2);


  vtkNew<vtkProperty> prop1;

  prop1->SetColor(1., 0., 1.);

  axis->SetAxisLinesProperty(prop1);

}


// ----------------------------------------------------------------------------

inline void InitializeZAxis(vtkAxisActor* axis)

{

  ::InitializeAxis(axis);


  axis->SetPoint2(0, 0, 10);

  axis->SetTitle("Z Axis");

  axis->SetBounds(0, 0, 0, 0, 0, 10);

  axis->SetTickLocationToOutside();

  axis->SetAxisTypeToZ();

  axis->SetRange(0, 10);

  axis->SetTitleAlignLocation(vtkAxisActor::VTK_ALIGN_POINT2);

  axis->SetExponentLocation(vtkAxisActor::VTK_ALIGN_POINT1);

  axis->SetTitleOffset(-80, -150);

  axis->SetExponentOffset(-150);

  axis->SetMajorTickSize(3);

  axis->SetMinorTickSize(1);

  axis->SetDeltaRangeMajor(2);

  axis->SetDeltaRangeMinor(0.5);


  axis->GetCamera()->SetPosition(0, 10, 0);

  axis->GetCamera()->SetViewUp(1, 0, 0);


  vtkNew<vtkTextProperty> textProp3;

  textProp3->SetColor(0., 1., 0.);

  textProp3->SetOpacity(1);

  axis->SetTitleTextProperty(textProp3);

}

}


// ----------------------------------------------------------------------------

inline void AddToWindow(vtkRenderWindow* renderWindow, vtkAxisActor* axis)

{

  vtkNew<vtkRenderer> renderer;

  renderer->SetActiveCamera(axis->GetCamera());

  renderer->AddActor(axis);

  renderer->SetBackground(.5, .5, .5);


  renderWindow->AddRenderer(renderer);


  renderWindow->SetSize(300, 300);

  renderWindow->SetMultiSamples(0);

  renderWindow->Render();

  renderer->ResetCameraScreenSpace(0.8);

}


// ----------------------------------------------------------------------------

inline int TestAxisActorInternal(vtkAxisActor* axis)

{

  vtkNew<vtkRenderWindow> renderWindow;

  ::AddToWindow(renderWindow, axis);


  vtkNew<vtkRenderWindowInteractor> renderWindowInteractor;

  renderWindowInteractor->SetRenderWindow(renderWindow);


  renderWindow->Render();

  renderWindowInteractor->Start();


  return EXIT_SUCCESS;

}


#endif

TestAxisActorInternal
int TestAxisActorInternal(vtkAxisActor *axis)
Definition TestAxisActorInternal.h:161

AddToWindow
void AddToWindow(vtkRenderWindow *renderWindow, vtkAxisActor *axis)
Definition TestAxisActorInternal.h:145

vtkAxisActor
Create an axis with tick marks and labels.
Definition vtkAxisActor.h:92

vtkAxisActor::SetTickLocationToBoth
void SetTickLocationToBoth()
Definition vtkAxisActor.h:227

vtkAxisActor::SetCamera
virtual void SetCamera(vtkCamera *)
Set/Get the camera for this axis.

vtkAxisActor::SetLog
virtual void SetLog(bool)
Set/Get The type of scale, enable logarithmic scale or linear by default.

vtkAxisActor::SetExponentOffset
virtual void SetExponentOffset(double)
Set/Get the Y-offset used to position exponent.

vtkAxisActor::SetMajorTickSize
virtual void SetMajorTickSize(double)
Set/Get the size of major tick marks.

vtkAxisActor::SetMinorTickSize
virtual void SetMinorTickSize(double)
Set/Get the size of minor tick marks.

vtkAxisActor::SetPoint2
virtual void SetPoint2(double x[3])
Specify the position of the second point defining the axis.
Definition vtkAxisActor.h:117

vtkAxisActor::SetAxisMainLineProperty
void SetAxisMainLineProperty(vtkProperty *)
Get/Set main line axis actor property.

vtkAxisActor::VTK_ALIGN_TOP
@ VTK_ALIGN_TOP
Definition vtkAxisActor.h:291

vtkAxisActor::VTK_ALIGN_POINT2
@ VTK_ALIGN_POINT2
Definition vtkAxisActor.h:294

vtkAxisActor::VTK_ALIGN_POINT1
@ VTK_ALIGN_POINT1
Definition vtkAxisActor.h:293

vtkAxisActor::SetBounds
void SetBounds(const double bounds[6])
Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

vtkAxisActor::SetExponent
void SetExponent(const std::string &exp)
Set/Get the common exponent of the labels values.

vtkAxisActor::SetAxisTypeToZ
void SetAxisTypeToZ()
Set/Get the type of this axis.
Definition vtkAxisActor.h:463

vtkAxisActor::SetTitle
void SetTitle(const std::string &title)
Set/Get the title of the axis actor.

vtkAxisActor::SetRange
virtual void SetRange(double, double)
Specify the (min,max) axis range.

vtkAxisActor::SetLabelTextProperty
virtual void SetLabelTextProperty(vtkTextProperty *p)
Set/Get the axis labels text property.

vtkAxisActor::SetMajorRangeStart
virtual void SetMajorRangeStart(double)
Set/Get the starting position for minor and major tick points on the range.

vtkAxisActor::SetExponentLocation
virtual void SetExponentLocation(int location)
Get/Set the location of the Detached Exponent related to the axis.

vtkAxisActor::GetCamera
vtkCamera * GetCamera()
Set/Get the camera for this axis.

vtkAxisActor::SetPoint1
virtual void SetPoint1(double x[3])
Specify the position of the first point defining the axis.
Definition vtkAxisActor.h:107

vtkAxisActor::SetAxisLinesProperty
void SetAxisLinesProperty(vtkProperty *)
Get/Set axis actor property (axis and its ticks) (kept for compatibility)

vtkAxisActor::SetDeltaRangeMajor
virtual void SetDeltaRangeMajor(double)
Set/Get the delta range for minor and major tick points that determine their spacing.

vtkAxisActor::SetDeltaRangeMinor
virtual void SetDeltaRangeMinor(double)
Set/Get the delta range for minor and major tick points that determine their spacing.

vtkAxisActor::SetAxisMajorTicksProperty
void SetAxisMajorTicksProperty(vtkProperty *)
Get/Set axis actor property (axis and its ticks)

vtkAxisActor::SetLabelScale
void SetLabelScale(double scale)
Set scale on underlying actor.

vtkAxisActor::SetTickLocationToOutside
void SetTickLocationToOutside()
Definition vtkAxisActor.h:226

vtkAxisActor::SetAxisTypeToY
void SetAxisTypeToY()
Set/Get the type of this axis.
Definition vtkAxisActor.h:462

vtkAxisActor::SetAxisTypeToX
void SetAxisTypeToX()
Set/Get the type of this axis.
Definition vtkAxisActor.h:461

vtkAxisActor::SetLabelOffset
virtual void SetLabelOffset(double)
Set/Get the Y-offset used to position label.

vtkAxisActor::SetTitleScale
void SetTitleScale(double scale)
Set scale on underlying actor.

vtkAxisActor::SetTitleAlignLocation
virtual void SetTitleAlignLocation(int location)
Get/Set the alignment of the title related to the axis.

vtkAxisActor::SetTitleTextProperty
virtual void SetTitleTextProperty(vtkTextProperty *p)
Set/Get the axis title text property.

vtkAxisActor::SetMinorTicksVisible
virtual void SetMinorTicksVisible(bool)
Set/Get the flag that controls whether the minor ticks are visible.

vtkAxisActor::SetTickLocationToInside
void SetTickLocationToInside()
Definition vtkAxisActor.h:225

vtkAxisActor::SetLabels
void SetLabels(vtkStringArray *labels)

vtkAxisActor::SetAxisMinorTicksProperty
void SetAxisMinorTicksProperty(vtkProperty *)
Get/Set axis actor property (axis and its ticks)

vtkAxisActor::SetMinorRangeStart
virtual void SetMinorRangeStart(double)
Set/Get the starting position for minor and major tick points on the range.

vtkAxisActor::SetTitleOffset
virtual void SetTitleOffset(double, double)
Set/Get the 2D-offsets used to position title texts.

vtkAxisActor::SetExponentVisibility
virtual void SetExponentVisibility(bool)
Set/Get visibility of the axis detached exponent.

vtkCamera::SetPosition
void SetPosition(double x, double y, double z)
Set/Get the position of the camera in world coordinates.

vtkCamera::SetViewUp
void SetViewUp(double vx, double vy, double vz)
Set/Get the view up direction for the camera.

vtkNew
Allocate and hold a VTK object.
Definition vtkNew.h:167

vtkRenderWindow
create a window for renderers to draw into
Definition vtkRenderWindow.h:197

vtkRenderWindow::AddRenderer
virtual void AddRenderer(vtkRenderer *)
Add a renderer to the list of renderers.

vtkRenderWindow::Render
void Render() override
Ask each renderer owned by this RenderWindow to render its image and synchronize this process.

vtkRenderWindow::SetMultiSamples
virtual void SetMultiSamples(int)
Set / Get the number of multisamples to use for hardware antialiasing.

vtkWindow::SetSize
virtual void SetSize(int width, int height)
Set the size (width and height) of the rendering window in screen coordinates (in pixels).

vtkAxisActor.h

vtkCamera.h

vtkNew.h

vtkPolyDataMapper.h

vtkProperty.h

vtkRenderWindowInteractor.h

vtkRenderWindow.h

vtkRenderer.h

vtkStringArray.h

vtkTextProperty.h