copy oriented and scaled glyph geometry to every input point More...

#include <vtkGlyph3D.h>

Inheritance diagram for vtkGlyph3D:

Collaboration diagram for vtkGlyph3D:

Public Types
typedef vtkPolyDataAlgorithm	Superclass

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

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.

vtkGlyph3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetSourceData (vtkPolyData *pd)
	Set the source to use for the glyph.

void	SetSourceData (int id, vtkPolyData *pd)
	Specify a source object at a specified table location.

vtkPolyData *	GetSource (int id=0)
	Get a pointer to a source object at a specified table location.

virtual int	IsPointVisible (vtkDataSet *, vtkIdType)
	This can be overwritten by subclass to return 0 when a point is blanked.

vtkMTimeType	GetMTime () override
	Overridden to include SourceTransform's MTime.


void	SetSourceConnection (int id, vtkAlgorithmOutput *algOutput)
	Specify a source object at a specified table location.

void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify a source object at a specified table location.


virtual void	SetScaling (vtkTypeBool)
	Turn on/off scaling of source geometry.

virtual void	ScalingOn ()
	Turn on/off scaling of source geometry.

virtual void	ScalingOff ()
	Turn on/off scaling of source geometry.

virtual vtkTypeBool	GetScaling ()
	Turn on/off scaling of source geometry.


virtual void	SetScaleMode (int)
	Either scale by scalar or by vector/normal magnitude.

virtual int	GetScaleMode ()
	Either scale by scalar or by vector/normal magnitude.

void	SetScaleModeToScaleByScalar ()
	Either scale by scalar or by vector/normal magnitude.

void	SetScaleModeToScaleByVector ()
	Either scale by scalar or by vector/normal magnitude.

void	SetScaleModeToScaleByVectorComponents ()
	Either scale by scalar or by vector/normal magnitude.

void	SetScaleModeToDataScalingOff ()
	Either scale by scalar or by vector/normal magnitude.

const char *	GetScaleModeAsString ()
	Return the method of scaling as a descriptive character string.


virtual void	SetColorMode (int)
	Either color by scale, scalar or by vector/normal magnitude.

virtual int	GetColorMode ()
	Either color by scale, scalar or by vector/normal magnitude.

void	SetColorModeToColorByScale ()
	Either color by scale, scalar or by vector/normal magnitude.

void	SetColorModeToColorByScalar ()
	Either color by scale, scalar or by vector/normal magnitude.

void	SetColorModeToColorByVector ()
	Either color by scale, scalar or by vector/normal magnitude.

const char *	GetColorModeAsString ()
	Return the method of coloring as a descriptive character string.


virtual void	SetScaleFactor (double)
	Specify scale factor to scale object by.

virtual double	GetScaleFactor ()
	Specify scale factor to scale object by.


virtual void	SetRange (double, double)
	Specify range to map scalar values into.

void	SetRange (double[2])
	Specify range to map scalar values into.

virtual double *	GetRange ()
	Specify range to map scalar values into.

virtual void	GetRange (double data[2])
	Specify range to map scalar values into.


virtual void	SetOrient (vtkTypeBool)
	Turn on/off orienting of input geometry along vector/normal.

virtual void	OrientOn ()
	Turn on/off orienting of input geometry along vector/normal.

virtual void	OrientOff ()
	Turn on/off orienting of input geometry along vector/normal.

virtual vtkTypeBool	GetOrient ()
	Turn on/off orienting of input geometry along vector/normal.


virtual void	SetClamping (vtkTypeBool)
	Turn on/off clamping of "scalar" values to range.

virtual void	ClampingOn ()
	Turn on/off clamping of "scalar" values to range.

virtual void	ClampingOff ()
	Turn on/off clamping of "scalar" values to range.

virtual vtkTypeBool	GetClamping ()
	Turn on/off clamping of "scalar" values to range.


virtual void	SetVectorMode (int)
	Specify whether to use vector or normal to perform vector operations.

virtual int	GetVectorMode ()
	Specify whether to use vector or normal to perform vector operations.

void	SetVectorModeToUseVector ()
	Specify whether to use vector or normal to perform vector operations.

void	SetVectorModeToUseNormal ()
	Specify whether to use vector or normal to perform vector operations.

void	SetVectorModeToVectorRotationOff ()
	Specify whether to use vector or normal to perform vector operations.

void	SetVectorModeToFollowCameraDirection ()
	Specify whether to use vector or normal to perform vector operations.

const char *	GetVectorModeAsString ()
	Return the vector mode as a character string.


virtual void	SetFollowedCameraPosition (double data[])
	Set/Get point position glyphs will face towards.

virtual double *	GetFollowedCameraPosition ()
	Set/Get point position glyphs will face towards.

virtual void	GetFollowedCameraPosition (double data[3])
	Set/Get point position glyphs will face towards.


virtual void	SetFollowedCameraViewUp (double data[])
	Set/Get glyphs up direction.

virtual double *	GetFollowedCameraViewUp ()
	Set/Get glyphs up direction.

virtual void	GetFollowedCameraViewUp (double data[3])
	Set/Get glyphs up direction.


virtual void	SetIndexMode (int)
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

virtual int	GetIndexMode ()
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

void	SetIndexModeToScalar ()
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

void	SetIndexModeToVector ()
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

void	SetIndexModeToOff ()
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

const char *	GetIndexModeAsString ()
	Return the index mode as a character string.


virtual void	SetGeneratePointIds (vtkTypeBool)
	Enable/disable the generation of point ids as part of the output.

virtual vtkTypeBool	GetGeneratePointIds ()
	Enable/disable the generation of point ids as part of the output.

virtual void	GeneratePointIdsOn ()
	Enable/disable the generation of point ids as part of the output.

virtual void	GeneratePointIdsOff ()
	Enable/disable the generation of point ids as part of the output.


virtual void	SetPointIdsName (const char *)
	Set/Get the name of the PointIds array if generated.

virtual char *	GetPointIdsName ()
	Set/Get the name of the PointIds array if generated.


virtual void	SetFillCellData (vtkTypeBool)
	Enable/disable the generation of cell data as part of the output.

virtual vtkTypeBool	GetFillCellData ()
	Enable/disable the generation of cell data as part of the output.

virtual void	FillCellDataOn ()
	Enable/disable the generation of cell data as part of the output.

virtual void	FillCellDataOff ()
	Enable/disable the generation of cell data as part of the output.


void	SetSourceTransform (vtkTransform *)
	When set, this is use to transform the source polydata before using it to generate the glyph.

virtual vtkTransform *	GetSourceTransform ()
	When set, this is use to transform the source polydata before using it to generate the glyph.


virtual void	SetOutputPointsPrecision (int)
	Set/get the desired precision for the output types.

virtual int	GetOutputPointsPrecision ()
	Set/get the desired precision for the output types.

Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkPolyDataAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

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.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkGlyph3D *	SafeDownCast (vtkObjectBase *o)

static vtkGlyph3D *	New ()
	Construct object with scaling on, scaling mode is by scalar value, scale factor = 1.0, the range is (0,1), orient geometry is on, and orientation is by vector.

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGlyph3D ()

	~vtkGlyph3D () override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.

vtkPolyData *	GetSource (int idx, vtkInformationVector *sourceInfo)


virtual bool	Execute (vtkDataSet input, vtkInformationVector sourceVector, vtkPolyData *output)
	Method called in RequestData() to do the actual data processing.

virtual bool	Execute (vtkDataSet input, vtkInformationVector sourceVector, vtkPolyData output, vtkDataArray inSScalars, vtkDataArray *inVectors)
	Method called in RequestData() to do the actual data processing.

Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called by the superclass.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

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
vtkPolyData **	Source

vtkTypeBool	Scaling

int	ScaleMode

int	ColorMode

double	ScaleFactor

double	Range [2]

int	Orient

int	VectorMode

double	FollowedCameraPosition [3]

double	FollowedCameraViewUp [3]

vtkTypeBool	Clamping

int	IndexMode

vtkTypeBool	GeneratePointIds

vtkTypeBool	FillCellData

char *	PointIdsName

vtkTransform *	SourceTransform

int	OutputPointsPrecision

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

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
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

copy oriented and scaled glyph geometry to every input point

vtkGlyph3D is a filter that copies a geometric representation (called a glyph) to every point in the input dataset. The glyph is defined with polygonal data from a source filter input. The glyph may be oriented along the input vectors or normals, and it may be scaled according to scalar data or vector magnitude. More than one glyph may be used by creating a table of source objects, each defining a different glyph. If a table of glyphs is defined, then the table can be indexed into by using either scalar value or vector magnitude.

To use this object you'll have to provide an input dataset and a source to define the glyph. Then decide whether you want to scale the glyph and how to scale the glyph (using scalar value or vector magnitude). Next decide whether you want to orient the glyph, and whether to use the vector data or normal data to orient it. Finally, decide whether to use a table of glyphs, or just a single glyph. If you use a table of glyphs, you'll have to decide whether to index into it with scalar value or with vector magnitude.

Warning: The scaling of the glyphs is controlled by the ScaleFactor ivar multiplied by the scalar value at each point (if VTK_SCALE_BY_SCALAR is set), or multiplied by the vector magnitude (if VTK_SCALE_BY_VECTOR is set), Alternatively (if VTK_SCALE_BY_VECTORCOMPONENTS is set), the scaling may be specified for x,y,z using the vector components. The scale factor can be further controlled by enabling clamping using the Clamping ivar. If clamping is enabled, the scale is normalized by the Range ivar, and then multiplied by the scale factor. The normalization process includes clamping the scale value between (0,1).; Typically this object operates on input data with scalar and/or vector data. However, scalar and/or vector aren't necessary, and it can be used to copy data from a single source to each point. In this case the scale factor can be used to uniformly scale the glyphs.; The object uses "vector" data to scale glyphs, orient glyphs, and/or index into a table of glyphs. You can choose to use either the vector or normal data at each input point. Use the method SetVectorModeToUseVector() to use the vector input data, and SetVectorModeToUseNormal() to use the normal input data.; If you do use a table of glyphs, make sure to set the Range ivar to make sure the index into the glyph table is computed correctly.; You can turn off scaling of the glyphs completely by using the Scaling ivar. You can also turn off scaling due to data (either vector or scalar) by using the SetScaleModeToDataScalingOff() method.; You can set what arrays to use for the scalars, vectors, normals, and color scalars by using the SetInputArrayToProcess methods in vtkAlgorithm. The first array is scalars, the next vectors, the next normals and finally color scalars.

See also: vtkTensorGlyph

Examples:: vtkGlyph3D (Examples)

Online Examples:

CurvatureBandsWithGlyphs

Tests:: vtkGlyph3D (Tests)

Definition at line 210 of file vtkGlyph3D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkGlyph3D::Superclass

Definition at line 213 of file vtkGlyph3D.h.

Constructor & Destructor Documentation

◆ vtkGlyph3D()

vtkGlyph3D::vtkGlyph3D ( )

protected

◆ ~vtkGlyph3D()

vtkGlyph3D::~vtkGlyph3D ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkGlyph3D::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 vtkPolyDataAlgorithm.

Reimplemented in vtkGlyph2D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGlyph3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkGlyph2D.

◆ NewInstance()

vtkGlyph3D * vtkGlyph3D::NewInstance ( ) const

◆ PrintSelf()

void vtkGlyph3D::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 vtkAlgorithm.

◆ New()

static vtkGlyph3D * vtkGlyph3D::New ( )

static

Construct object with scaling on, scaling mode is by scalar value, scale factor = 1.0, the range is (0,1), orient geometry is on, and orientation is by vector.

Clamping and indexing are turned off. No initial sources are defined.

◆ SetSourceData() [1/2]

void vtkGlyph3D::SetSourceData ( vtkPolyData * pd )

inline

Set the source to use for the glyph.

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

Definition at line 230 of file vtkGlyph3D.h.

◆ SetSourceData() [2/2]

void vtkGlyph3D::SetSourceData	(	int	id,
		vtkPolyData *	pd
	)

Specify a source object at a specified table location.

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

◆ SetSourceConnection() [1/2]

void vtkGlyph3D::SetSourceConnection	(	int	id,
		vtkAlgorithmOutput *	algOutput
	)

Specify a source object at a specified table location.

New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

◆ SetSourceConnection() [2/2]

void vtkGlyph3D::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

inline

Specify a source object at a specified table location.

New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

Definition at line 247 of file vtkGlyph3D.h.

◆ GetSource() [1/2]

vtkPolyData * vtkGlyph3D::GetSource ( int id = 0 )

Get a pointer to a source object at a specified table location.

◆ SetScaling()

virtual void vtkGlyph3D::SetScaling ( vtkTypeBool )

virtual

Turn on/off scaling of source geometry.

◆ ScalingOn()

virtual void vtkGlyph3D::ScalingOn ( )

virtual

Turn on/off scaling of source geometry.

◆ ScalingOff()

virtual void vtkGlyph3D::ScalingOff ( )

virtual

Turn on/off scaling of source geometry.

◆ GetScaling()

virtual vtkTypeBool vtkGlyph3D::GetScaling ( )

virtual

Turn on/off scaling of source geometry.

◆ SetScaleMode()

virtual void vtkGlyph3D::SetScaleMode ( int )

virtual

Either scale by scalar or by vector/normal magnitude.

◆ GetScaleMode()

virtual int vtkGlyph3D::GetScaleMode ( )

virtual

Either scale by scalar or by vector/normal magnitude.

◆ SetScaleModeToScaleByScalar()

void vtkGlyph3D::SetScaleModeToScaleByScalar ( )

inline

Either scale by scalar or by vector/normal magnitude.

Definition at line 273 of file vtkGlyph3D.h.

◆ SetScaleModeToScaleByVector()

void vtkGlyph3D::SetScaleModeToScaleByVector ( )

inline

Either scale by scalar or by vector/normal magnitude.

Definition at line 274 of file vtkGlyph3D.h.

◆ SetScaleModeToScaleByVectorComponents()

void vtkGlyph3D::SetScaleModeToScaleByVectorComponents ( )

inline

Either scale by scalar or by vector/normal magnitude.

Definition at line 275 of file vtkGlyph3D.h.

◆ SetScaleModeToDataScalingOff()

void vtkGlyph3D::SetScaleModeToDataScalingOff ( )

inline

Either scale by scalar or by vector/normal magnitude.

Definition at line 279 of file vtkGlyph3D.h.

◆ GetScaleModeAsString()

const char * vtkGlyph3D::GetScaleModeAsString ( )

inline

Return the method of scaling as a descriptive character string.

Definition at line 487 of file vtkGlyph3D.h.

◆ SetColorMode()

virtual void vtkGlyph3D::SetColorMode ( int )

virtual

Either color by scale, scalar or by vector/normal magnitude.

◆ GetColorMode()

virtual int vtkGlyph3D::GetColorMode ( )

virtual

Either color by scale, scalar or by vector/normal magnitude.

◆ SetColorModeToColorByScale()

void vtkGlyph3D::SetColorModeToColorByScale ( )

inline

Either color by scale, scalar or by vector/normal magnitude.

Definition at line 289 of file vtkGlyph3D.h.

◆ SetColorModeToColorByScalar()

void vtkGlyph3D::SetColorModeToColorByScalar ( )

inline

Either color by scale, scalar or by vector/normal magnitude.

Definition at line 290 of file vtkGlyph3D.h.

◆ SetColorModeToColorByVector()

void vtkGlyph3D::SetColorModeToColorByVector ( )

inline

Either color by scale, scalar or by vector/normal magnitude.

Definition at line 291 of file vtkGlyph3D.h.

◆ GetColorModeAsString()

const char * vtkGlyph3D::GetColorModeAsString ( )

inline

Return the method of coloring as a descriptive character string.

Definition at line 506 of file vtkGlyph3D.h.

◆ SetScaleFactor()

virtual void vtkGlyph3D::SetScaleFactor ( double )

virtual

Specify scale factor to scale object by.

◆ GetScaleFactor()

virtual double vtkGlyph3D::GetScaleFactor ( )

virtual

Specify scale factor to scale object by.

◆ SetRange() [1/2]

virtual void vtkGlyph3D::SetRange	(	double	,
		double
	)

virtual

Specify range to map scalar values into.

◆ SetRange() [2/2]

void vtkGlyph3D::SetRange ( double [2] )

Specify range to map scalar values into.

◆ GetRange() [1/2]

virtual double * vtkGlyph3D::GetRange ( )

virtual

Specify range to map scalar values into.

◆ GetRange() [2/2]

virtual void vtkGlyph3D::GetRange ( double data[2] )

virtual

Specify range to map scalar values into.

◆ SetOrient()

virtual void vtkGlyph3D::SetOrient ( vtkTypeBool )

virtual

Turn on/off orienting of input geometry along vector/normal.

◆ OrientOn()

virtual void vtkGlyph3D::OrientOn ( )

virtual

Turn on/off orienting of input geometry along vector/normal.

◆ OrientOff()

virtual void vtkGlyph3D::OrientOff ( )

virtual

Turn on/off orienting of input geometry along vector/normal.

◆ GetOrient()

virtual vtkTypeBool vtkGlyph3D::GetOrient ( )

virtual

Turn on/off orienting of input geometry along vector/normal.

◆ SetClamping()

virtual void vtkGlyph3D::SetClamping ( vtkTypeBool )

virtual

Turn on/off clamping of "scalar" values to range.

(Scalar value may be vector magnitude if ScaleByVector() is enabled.)

◆ ClampingOn()

virtual void vtkGlyph3D::ClampingOn ( )

virtual

Turn on/off clamping of "scalar" values to range.

(Scalar value may be vector magnitude if ScaleByVector() is enabled.)

◆ ClampingOff()

virtual void vtkGlyph3D::ClampingOff ( )

virtual

Turn on/off clamping of "scalar" values to range.

(Scalar value may be vector magnitude if ScaleByVector() is enabled.)

◆ GetClamping()

virtual vtkTypeBool vtkGlyph3D::GetClamping ( )

virtual

Turn on/off clamping of "scalar" values to range.

(Scalar value may be vector magnitude if ScaleByVector() is enabled.)