Represents a PlotColorsWidthsBuilder to be used for plotting. More...

Inheritance diagram for NXOpen::PlotColorsWidthsBuilder:

Public Types
enum	Color { ColorAsDisplayed, ColorPartColors, ColorCustomPalette, ColorBlackOnWhite, ColorLegacyColors, ColorColorsByWidth }
	Specifies the color option to use when plotting. More...

enum	Width { WidthStandardWidths, WidthSingleWidth, WidthCustomThreeWidths, WidthCustomPalette }
	Specifies the primary selection of which type of width assignment to use. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
NXOpen::PlotColorsWidthsBuilder::Color	Colors ()
	Returns the color option to be used when plotting.

NXOpen::CDF *	CreateCdf ()
	Creates and returns a CDF object representing the Color Palette.

NXOpen::WidthDefinition *	CreateWidthDefinition ()
	Creates and returns a WidthDefinition object representing the Width Palette.

void	DefinePalette ()
	Initialize the Color Palette.

void	DefineWidths ()
	Initialize the Width dialog.

void	DeleteColors ()
	Delete drawing sheet colors Created in NX5.0.0.

void	DeleteWidths ()
	Delete drawing sheet widths Created in NX5.0.0.

void	EditColors ()
	Edit drawing sheet colors Created in NX5.0.0.

void	EditWidths ()
	Edit drawing sheet widths Created in NX5.0.0.

NXOpen::CDF *	GetCdf ()
	Returns a CDF object representing the Color Palette.

NXOpen::WidthDefinition *	GetWidthDefinition ()
	Returns a WidthDefinition object representing the Width Palette.

void	ResetColors ()
	Reset drawing sheet colors Created in NX5.0.0.

void	ResetWidths ()
	Reset drawing sheet widths Created in NX5.0.0.

void	RetrieveColors ()
	Retrieve drawing sheet colors Created in NX5.0.0.

void	RetrieveWidths ()
	Retrieve drawing sheet widths Created in NX5.0.0.

void	SaveColors ()
	Save drawing sheet colors Created in NX5.0.0.

void	SaveWidths ()
	Save drawing sheet widths Created in NX5.0.0.

void	SetColors (NXOpen::PlotColorsWidthsBuilder::Color colors)
	Sets the color option to be used when plotting.

void	SetUseDrawingSheetColors (bool useDrawingSheetColors)
	Sets the use drawing sheet colors.

void	SetUseDrawingSheetWidths (bool useDrawingSheetWidths)
	Sets the use drawing sheet widths.

void	SetWidths (NXOpen::PlotColorsWidthsBuilder::Width widths)
	Sets the width option.

bool	UseDrawingSheetColors ()
	Returns the use drawing sheet colors.

bool	UseDrawingSheetWidths ()
	Returns the use drawing sheet widths.

NXOpen::PlotColorsWidthsBuilder::Width	Widths ()
	Returns the width option.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

Represents a PlotColorsWidthsBuilder to be used for plotting.

The PlotColorsWidthsBuilder class maintains all colors and widths data, which will be used by the PlotBuilder. If the color option is set to Custom Palette or Colors By Width, the PlotBuilder will translate the CDF object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined colors. If the width option is set to Single Width, Custom Three Width, or Custom Palette, the PlotBuilder will translate the WidthDefinition object maintained by PlotColorsWidthsBuilder in order to plot with the user-defined widths.

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::PlotColorsWidthsBuilder::Color

Specifies the color option to use when plotting.

Enumerator:

ColorAsDisplayed	As Displayed.
ColorPartColors	Part Colors.
ColorCustomPalette	Custom Palette.
ColorBlackOnWhite	Black on White.
ColorLegacyColors	Legacy Colors.
ColorColorsByWidth	Colors by Width.

enum NXOpen::PlotColorsWidthsBuilder::Width

Specifies the primary selection of which type of width assignment to use.

Enumerator:

WidthStandardWidths	Standard Widths.
WidthSingleWidth	Single Width.
WidthCustomThreeWidths	Custom Three Widths.
WidthCustomPalette	Custom palette.

Member Function Documentation

NXOpen::PlotColorsWidthsBuilder::Color NXOpen::PlotColorsWidthsBuilder::Colors ( )

Returns the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.

License requirements : None

NXOpen::CDF* NXOpen::PlotColorsWidthsBuilder::CreateCdf ( )

Creates and returns a CDF object representing the Color Palette.

       This object contains all custom color information to be used when Custom Palette 
       or Colors By Width is selected from the Color option.  
    @return  CDF object

Created in NX5.0.0.

License requirements : None

NXOpen::WidthDefinition* NXOpen::PlotColorsWidthsBuilder::CreateWidthDefinition ( )

Creates and returns a WidthDefinition object representing the Width Palette.

This object contains all custom width information to be used when Single Width, Custom Three Widths, or Custom Palette is selected from the Width option.

Returns: WidthDefinition object
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::DefinePalette ( )

Initialize the Color Palette.

This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::DefineWidths ( )

Initialize the Width dialog.

This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::DeleteColors ( )

Delete drawing sheet colors
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::DeleteWidths ( )

Delete drawing sheet widths
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::EditColors ( )

Edit drawing sheet colors
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::EditWidths ( )

Edit drawing sheet widths
Created in NX5.0.0.

License requirements : None

NXOpen::CDF* NXOpen::PlotColorsWidthsBuilder::GetCdf ( )

Returns a CDF object representing the Color Palette.

       This object contains all custom color information to be used when Custom Palette or
       Colors By Width is selected from the Color option.
    @return  CDF object

Created in NX5.0.0.

License requirements : None

NXOpen::WidthDefinition* NXOpen::PlotColorsWidthsBuilder::GetWidthDefinition ( )

Returns a WidthDefinition object representing the Width Palette.

       This object contains all custom width information to be used when Single Width, Custom
       Three Widths, or Custom Palette is selected from the Width option.
    @return  WidthDefinition object

Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::ResetColors ( )

Reset drawing sheet colors
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::ResetWidths ( )

Reset drawing sheet widths
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::RetrieveColors ( )

Retrieve drawing sheet colors
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::RetrieveWidths ( )

Retrieve drawing sheet widths
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::SaveColors ( )

Save drawing sheet colors
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::SaveWidths ( )

Save drawing sheet widths
Created in NX5.0.0.

License requirements : None

void NXOpen::PlotColorsWidthsBuilder::SetColors ( NXOpen::PlotColorsWidthsBuilder::Color colors )

Sets the color option to be used when plotting.

If the color option is set to Custom Palette or Colors By Width then the plotter will use the user defined color attributes belonging to the CDF object.
Created in NX5.0.0.

License requirements : None

Parameters

colors colors

void NXOpen::PlotColorsWidthsBuilder::SetUseDrawingSheetColors ( bool useDrawingSheetColors )

Sets the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.
Created in NX5.0.0.

License requirements : None

Parameters

useDrawingSheetColors usedrawingsheetcolors

void NXOpen::PlotColorsWidthsBuilder::SetUseDrawingSheetWidths ( bool useDrawingSheetWidths )

Sets the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.
Created in NX5.0.0.

License requirements : None

Parameters

useDrawingSheetWidths usedrawingsheetwidths

void NXOpen::PlotColorsWidthsBuilder::SetWidths ( NXOpen::PlotColorsWidthsBuilder::Width widths )

Sets the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.0.0.

License requirements : None

Parameters

widths widths

bool NXOpen::PlotColorsWidthsBuilder::UseDrawingSheetColors ( )

Returns the use drawing sheet colors.

When this option is set to true, the plotter will use the user-defined drawing sheet colors.
Created in NX5.0.0.

License requirements : None

bool NXOpen::PlotColorsWidthsBuilder::UseDrawingSheetWidths ( )

Returns the use drawing sheet widths.

When this option is set to true, the plotter will use the user-defined drawing sheet widths.
Created in NX5.0.0.

License requirements : None

NXOpen::PlotColorsWidthsBuilder::Width NXOpen::PlotColorsWidthsBuilder::Widths ( )

Returns the width option.

If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the plotter will use the user defined width attributes belonging to the WidthDefinition object.
Created in NX5.0.0.

License requirements : None

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

PlotColorsWidthsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation