VTK  9.4.20250114
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCone Class Reference

implicit function for a cone More...

#include <vtkCone.h>

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

Public Types

typedef vtkImplicitFunction Superclass
 
- Public Types inherited from vtkImplicitFunction
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.
 
vtkConeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void EvaluateGradient (double x[3], double g[3]) override
 Evaluate cone normal.
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate function at position x-y-z and return value.
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value.
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate function at position x-y-z and return value.
 
double EvaluateFunction (double x[3]) override
 Evaluate cone equation.
 
virtual void SetAngle (double)
 Set/Get the cone angle (expressed in degrees).
 
virtual double GetAngle ()
 Set/Get the cone angle (expressed in degrees).
 
void SetOrigin (double x, double y, double z)
 Set/Get the cone origin.
 
void SetOrigin (const double xyz[3])
 Set/Get the cone origin.
 
virtual double * GetOrigin ()
 Set/Get the cone origin.
 
virtual void GetOrigin (double &, double &, double &)
 Set/Get the cone origin.
 
virtual void GetOrigin (double[3])
 Set/Get the cone origin.
 
void SetAxis (double x, double y, double z)
 Get/Set the vector defining the direction of the cone.
 
void SetAxis (double axis[3])
 Get/Set the vector defining the direction of the cone.
 
virtual double * GetAxis ()
 Get/Set the vector defining the direction of the cone.
 
virtual void GetAxis (double &, double &, double &)
 Get/Set the vector defining the direction of the cone.
 
virtual void GetAxis (double[3])
 Get/Set the vector defining the direction of the cone.
 
virtual void SetIsDoubleCone (bool)
 Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).
 
virtual bool GetIsDoubleCone ()
 Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).
 
virtual void IsDoubleConeOn ()
 Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).
 
virtual void IsDoubleConeOff ()
 Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).
 
- Public Member Functions inherited from vtkImplicitFunction
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkImplicitFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkMTimeType GetMTime () override
 Overload standard modified time function.
 
virtual void EvaluateGradient (double x[3], double g[3])=0
 Evaluate function gradient at position x-y-z and pass back vector.
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value.
 
double FunctionValue (const double x[3])
 Evaluate function at position x-y-z and return value.
 
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value.
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector.
 
double * FunctionGradient (const double x[3])
 Evaluate function gradient at position x-y-z and pass back vector.
 
double * FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector.
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function.
 
virtual void SetTransform (const double elements[16])
 Set/Get a transformation to apply to input points before executing the implicit function.
 
virtual vtkAbstractTransformGetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function.
 
- 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 vtkConeNew ()
 Construct cone with angle of 45 degrees.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkConeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkCone ()=default
 
 ~vtkCone () override=default
 
- Protected Member Functions inherited from vtkImplicitFunction
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () 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

double Angle = 45.0
 
double Origin [3] = { 0.0, 0.0, 0.0 }
 
double Axis [3] = { 1.0, 0.0, 0.0 }
 
bool IsDoubleCone = true
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- 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

implicit function for a cone

vtkCone computes the implicit function and function gradient for a cone. vtkCone is a concrete implementation of vtkImplicitFunction. By default, the cone vertex is located at the origin with axis of rotation coincident with x-axis. You can use the superclass' vtkImplicitFunction transformation matrix to reposition. You can alternatively use the accessors provided by this class, which will cause the transform to be recomputed. to reposition/orient the cone. The angle specifies the angle between the axis of rotation and the side of the cone.

Warning
The cone is infinite in extent (on both sides if IsDoubleCone is set to true). To truncate the cone use the vtkImplicitBoolean in combination with clipping planes.
Online Examples:

Tests:
vtkCone (Tests)

Definition at line 90 of file vtkCone.h.

Member Typedef Documentation

◆ Superclass

Definition at line 98 of file vtkCone.h.

Constructor & Destructor Documentation

◆ vtkCone()

vtkCone::vtkCone ( )
protecteddefault

◆ ~vtkCone()

vtkCone::~vtkCone ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkCone * vtkCone::New ( )
static

Construct cone with angle of 45 degrees.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCone::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 vtkImplicitFunction.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCone::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkCone * vtkCone::NewInstance ( ) const

◆ PrintSelf()

void vtkCone::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.

◆ EvaluateFunction() [1/4]

double vtkCone::EvaluateFunction ( double  x[3])
overridevirtual

Evaluate cone equation.

Implements vtkImplicitFunction.

◆ EvaluateGradient()

void vtkCone::EvaluateGradient ( double  x[3],
double  g[3] 
)
overridevirtual

Evaluate cone normal.

Implements vtkImplicitFunction.

◆ SetAngle()

virtual void vtkCone::SetAngle ( double  )
virtual

Set/Get the cone angle (expressed in degrees).

Defaults to 45 degrees.

◆ GetAngle()

virtual double vtkCone::GetAngle ( )
virtual

Set/Get the cone angle (expressed in degrees).

Defaults to 45 degrees.

◆ SetOrigin() [1/2]

void vtkCone::SetOrigin ( double  x,
double  y,
double  z 
)

Set/Get the cone origin.

Defaults to (0, 0, 0).

◆ SetOrigin() [2/2]

void vtkCone::SetOrigin ( const double  xyz[3])

Set/Get the cone origin.

Defaults to (0, 0, 0).

◆ GetOrigin() [1/3]

virtual double * vtkCone::GetOrigin ( )
virtual

Set/Get the cone origin.

Defaults to (0, 0, 0).

◆ GetOrigin() [2/3]

virtual void vtkCone::GetOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set/Get the cone origin.

Defaults to (0, 0, 0).

◆ GetOrigin() [3/3]

virtual void vtkCone::GetOrigin ( double  [3])
virtual

Set/Get the cone origin.

Defaults to (0, 0, 0).

◆ SetAxis() [1/2]

void vtkCone::SetAxis ( double  x,
double  y,
double  z 
)

Get/Set the vector defining the direction of the cone.

If the axis is not specified as a unit vector, it will be normalized. If zero-length axis vector is used as input to this method, it will be ignored. Defaults to the X axis (1, 0, 0).

◆ SetAxis() [2/2]

void vtkCone::SetAxis ( double  axis[3])

Get/Set the vector defining the direction of the cone.

If the axis is not specified as a unit vector, it will be normalized. If zero-length axis vector is used as input to this method, it will be ignored. Defaults to the X axis (1, 0, 0).

◆ GetAxis() [1/3]

virtual double * vtkCone::GetAxis ( )
virtual

Get/Set the vector defining the direction of the cone.

If the axis is not specified as a unit vector, it will be normalized. If zero-length axis vector is used as input to this method, it will be ignored. Defaults to the X axis (1, 0, 0).

◆ GetAxis() [2/3]

virtual void vtkCone::GetAxis ( double &  ,
double &  ,
double &   
)
virtual

Get/Set the vector defining the direction of the cone.

If the axis is not specified as a unit vector, it will be normalized. If zero-length axis vector is used as input to this method, it will be ignored. Defaults to the X axis (1, 0, 0).

◆ GetAxis() [3/3]

virtual void vtkCone::GetAxis ( double  [3])
virtual

Get/Set the vector defining the direction of the cone.

If the axis is not specified as a unit vector, it will be normalized. If zero-length axis vector is used as input to this method, it will be ignored. Defaults to the X axis (1, 0, 0).

◆ SetIsDoubleCone()

virtual void vtkCone::SetIsDoubleCone ( bool  )
virtual

Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).

vtkCone is a double cone by default.

◆ GetIsDoubleCone()

virtual bool vtkCone::GetIsDoubleCone ( )
virtual

Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).

vtkCone is a double cone by default.

◆ IsDoubleConeOn()

virtual void vtkCone::IsDoubleConeOn ( )
virtual

Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).

vtkCone is a double cone by default.

◆ IsDoubleConeOff()

virtual void vtkCone::IsDoubleConeOff ( )
virtual

Set/Get whether this is a double cone (extends to infinity on both directions along axis) or a one sided one (extends towards the axis direction only).

vtkCone is a double cone by default.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x[3])
virtual

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction ( vtkDataArray input,
vtkDataArray output 
)
virtual

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x,
double  y,
double  z 
)
inlinevirtual

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Reimplemented from vtkImplicitFunction.

Definition at line 131 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Angle

double vtkCone::Angle = 45.0
protected

Definition at line 161 of file vtkCone.h.

◆ Origin

double vtkCone::Origin[3] = { 0.0, 0.0, 0.0 }
protected

Definition at line 162 of file vtkCone.h.

◆ Axis

double vtkCone::Axis[3] = { 1.0, 0.0, 0.0 }
protected

Definition at line 163 of file vtkCone.h.

◆ IsDoubleCone

bool vtkCone::IsDoubleCone = true
protected

Definition at line 164 of file vtkCone.h.


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