ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkGenericAttributeCollection Class Reference

vtkGenericAttributeCollection - a collection of attributes More...

Inheritance diagram for Kitware.VTK.vtkGenericAttributeCollection:
[legend]
Collaboration diagram for Kitware.VTK.vtkGenericAttributeCollection:
[legend]

List of all members.

Public Member Functions

 vtkGenericAttributeCollection (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGenericAttributeCollection ()
 Create an empty collection.
void DeepCopy (vtkGenericAttributeCollection other)
 Copy, without reference counting, the other attribute array.
int FindAttribute (string name)
 Return the index of the attribute named `name'. Return the non-negative index if found. Return -1 otherwise.
virtual int GetActiveAttribute ()
 Index of the attribute to be processed (not necessarily scalar).
virtual int GetActiveComponent ()
 Component of the active attribute to be processed. -1 means module.
uint GetActualMemorySize ()
 Actual size of the data in kilobytes; only valid after the pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the data.
vtkGenericAttribute GetAttribute (int i)
 Return a pointer to the ith instance of vtkGenericAttribute.
int GetAttributeIndex (int i)
 Return the index of the first component of attribute `i' in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ...
IntPtr GetAttributesToInterpolate ()
 Number of attributes to interpolate.
override uint GetMTime ()
 vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.
int GetMaxNumberOfComponents ()
 Maximum number of components encountered among all attributes.
int GetNumberOfAttributes ()
 Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.
virtual int GetNumberOfAttributesToInterpolate ()
 Number of attributes to interpolate.
int GetNumberOfComponents ()
 Return the number of components. This is the sum of all components found in all attributes.
int GetNumberOfPointCenteredComponents ()
 Return the number of components. This is the sum of all components found in all point centered attributes.
int HasAttribute (int size, IntPtr attributes, int attribute)
 Description Does the array `attributes' of size `size' have `attribute'?
void InsertAttribute (int i, vtkGenericAttribute a)
 Replace the attribute at index `i' by `a'.
void InsertNextAttribute (vtkGenericAttribute a)
 Add the attribute `a' to the end of the collection.
override int IsA (string type)
 Standard type definition and print methods for a VTK class.
int IsEmpty ()
 Indicate whether the collection contains any attributes.
new vtkGenericAttributeCollection NewInstance ()
 Standard type definition and print methods for a VTK class.
void RemoveAttribute (int i)
 Remove the attribute at `i'.
void Reset ()
 Remove all attributes.
void SetActiveAttribute (int attribute, int component)
 Set the scalar attribute to be processed. -1 means module.
void SetAttributesToInterpolate (int size, IntPtr attributes)
 Set the attributes to interpolate.
void SetAttributesToInterpolateToAll ()
 Set the attributes to interpolate.
void ShallowCopy (vtkGenericAttributeCollection other)
 Copy, via reference counting, the other attribute array.

Static Public Member Functions

static new
vtkGenericAttributeCollection 
New ()
 Create an empty collection.
static new int IsTypeOf (string type)
 Standard type definition and print methods for a VTK class.
static new
vtkGenericAttributeCollection 
SafeDownCast (vtkObjectBase o)
 Standard type definition and print methods for a VTK class.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkGenericAttributeCollection"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "29vtkGenericAttributeCollection"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkGenericAttributeCollection_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericAttributeCollection_DeepCopy_01 (HandleRef pThis, HandleRef other)
static internal int vtkGenericAttributeCollection_FindAttribute_02 (HandleRef pThis, string name)
static internal int vtkGenericAttributeCollection_GetActiveAttribute_03 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetActiveComponent_04 (HandleRef pThis)
static internal uint vtkGenericAttributeCollection_GetActualMemorySize_05 (HandleRef pThis)
static internal IntPtr vtkGenericAttributeCollection_GetAttribute_06 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkGenericAttributeCollection_GetAttributeIndex_07 (HandleRef pThis, int i)
static internal IntPtr vtkGenericAttributeCollection_GetAttributesToInterpolate_08 (HandleRef pThis)
static internal uint vtkGenericAttributeCollection_GetMTime_09 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetMaxNumberOfComponents_10 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetNumberOfAttributes_11 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetNumberOfAttributesToInterpolate_12 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetNumberOfComponents_13 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_GetNumberOfPointCenteredComponents_14 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_HasAttribute_15 (HandleRef pThis, int size, IntPtr attributes, int attribute)
static internal void vtkGenericAttributeCollection_InsertAttribute_16 (HandleRef pThis, int i, HandleRef a)
static internal void vtkGenericAttributeCollection_InsertNextAttribute_17 (HandleRef pThis, HandleRef a)
static internal int vtkGenericAttributeCollection_IsA_18 (HandleRef pThis, string type)
static internal int vtkGenericAttributeCollection_IsEmpty_19 (HandleRef pThis)
static internal int vtkGenericAttributeCollection_IsTypeOf_20 (string type)
static internal IntPtr vtkGenericAttributeCollection_NewInstance_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericAttributeCollection_RemoveAttribute_23 (HandleRef pThis, int i)
static internal void vtkGenericAttributeCollection_Reset_24 (HandleRef pThis)
static internal IntPtr vtkGenericAttributeCollection_SafeDownCast_25 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericAttributeCollection_SetActiveAttribute_26 (HandleRef pThis, int attribute, int component)
static internal void vtkGenericAttributeCollection_SetAttributesToInterpolate_27 (HandleRef pThis, int size, IntPtr attributes)
static internal void vtkGenericAttributeCollection_SetAttributesToInterpolateToAll_28 (HandleRef pThis)
static internal void vtkGenericAttributeCollection_ShallowCopy_29 (HandleRef pThis, HandleRef other)

Static Private Member Functions

static vtkGenericAttributeCollection ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGenericAttributeCollection - a collection of attributes

Description vtkGenericAttributeCollection is a class that collects attributes (represented by vtkGenericAttribute).


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Create an empty collection.


Member Function Documentation

Copy, without reference counting, the other attribute array.

Precondition:
other_exists: other!=0
not_self: other!=this
Postcondition:
same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()
override void Kitware.VTK.vtkGenericAttributeCollection.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Return the index of the attribute named `name'. Return the non-negative index if found. Return -1 otherwise.

Precondition:
name_exists: name!=0
Postcondition:
valid_result: (result==-1) || (result>=0) && (result<=GetNumberOfAttributes())

Index of the attribute to be processed (not necessarily scalar).

Precondition:
not_empty: !IsEmpty()
Postcondition:
valid_result: result>=0 && result<GetNumberOfAttributes()

Component of the active attribute to be processed. -1 means module.

Precondition:
not_empty: GetNumberOfAttributes()>0
Postcondition:
valid_result: result>=-1 && result<GetAttribute(GetActiveAttribute())->GetNumberOfComponents()

Actual size of the data in kilobytes; only valid after the pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the data.

Return a pointer to the ith instance of vtkGenericAttribute.

Precondition:
not_empty: !IsEmpty()
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition:
result_exists: result!=0

Here is the call graph for this function:

Return the index of the first component of attribute `i' in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ...

Precondition:
valid_i: i>=0 && i<GetNumberOfAttributes()
is_point_centered: GetAttribute(i)->GetCentering()==vtkPointCentered

Number of attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
Postcondition:
positive_result: result>=0

Maximum number of components encountered among all attributes.

Postcondition:
positive_result: result>=0
valid_result: result<=GetNumberOfComponents()

vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.

Reimplemented from Kitware.VTK.vtkObject.

Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.

Postcondition:
positive_result: result>=0

Number of attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
Postcondition:
positive_result: result>=0

Return the number of components. This is the sum of all components found in all attributes.

Postcondition:
positive_result: result>=0

Return the number of components. This is the sum of all components found in all point centered attributes.

Postcondition:
positive_result: result>=0
int Kitware.VTK.vtkGenericAttributeCollection.HasAttribute ( int  size,
IntPtr  attributes,
int  attribute 
)

Description Does the array `attributes' of size `size' have `attribute'?

Precondition:
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0

Replace the attribute at index `i' by `a'.

Precondition:
not_empty: !IsEmpty()
a_exists: a!=0
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition:
same_size: GetNumberOfAttributes()==old GetNumberOfAttributes()
item_is_set: GetAttribute(i)==a

Add the attribute `a' to the end of the collection.

Precondition:
a_exists: a!=0
Postcondition:
more_items: GetNumberOfAttributes()==old GetNumberOfAttributes()+1
a_is_set: GetAttribute(GetNumberOfAttributes()-1)==a
override int Kitware.VTK.vtkGenericAttributeCollection.IsA ( string  type) [virtual]

Standard type definition and print methods for a VTK class.

Reimplemented from Kitware.VTK.vtkObject.

Indicate whether the collection contains any attributes.

Postcondition:
definition: result==(GetNumberOfAttributes()==0)
static new int Kitware.VTK.vtkGenericAttributeCollection.IsTypeOf ( string  type) [static]

Standard type definition and print methods for a VTK class.

Reimplemented from Kitware.VTK.vtkObject.

Create an empty collection.

Reimplemented from Kitware.VTK.vtkObject.

Standard type definition and print methods for a VTK class.

Reimplemented from Kitware.VTK.vtkObject.

Remove the attribute at `i'.

Precondition:
not_empty: !IsEmpty()
valid_i: i>=0 && i<GetNumberOfAttributes()
Postcondition:
fewer_items: GetNumberOfAttributes()==old GetNumberOfAttributes()-1

Remove all attributes.

Postcondition:
is_empty: GetNumberOfAttributes()==0

Standard type definition and print methods for a VTK class.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

void Kitware.VTK.vtkGenericAttributeCollection.SetActiveAttribute ( int  attribute,
int  component 
)

Set the scalar attribute to be processed. -1 means module.

Precondition:
not_empty: !IsEmpty()
valid_attribute: attribute>=0 && attribute<GetNumberOfAttributes()
valid_component: component>=-1 && component<GetAttribute(attribute)->GetNumberOfComponents()
Postcondition:
is_set: GetActiveAttribute()==attribute && GetActiveComponent()==component

Set the attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())
Postcondition:
is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)

Set the attributes to interpolate.

Precondition:
not_empty: !IsEmpty()
positive_size: size>=0
valid_attributes: size>0 implies attributes!=0
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute())
Postcondition:
is_set: (GetNumberOfAttributesToInterpolate()==size)&& (GetAttributesToInterpolate()==attributes)

Copy, via reference counting, the other attribute array.

Precondition:
other_exists: other!=0
not_self: other!=this
Postcondition:
same_size: GetNumberOfAttributes()==other->GetNumberOfAttributes()
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_DeepCopy_01 ( HandleRef  pThis,
HandleRef  other 
) [private]
static internal int Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_FindAttribute_02 ( HandleRef  pThis,
string  name 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_GetAttribute_06 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_GetAttributeIndex_07 ( HandleRef  pThis,
int  i 
) [private]
static internal int Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_HasAttribute_15 ( HandleRef  pThis,
int  size,
IntPtr  attributes,
int  attribute 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_InsertAttribute_16 ( HandleRef  pThis,
int  i,
HandleRef  a 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_InsertNextAttribute_17 ( HandleRef  pThis,
HandleRef  a 
) [private]
static internal int Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_NewInstance_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_RemoveAttribute_23 ( HandleRef  pThis,
int  i 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_Reset_24 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_SafeDownCast_25 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_SetActiveAttribute_26 ( HandleRef  pThis,
int  attribute,
int  component 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_SetAttributesToInterpolate_27 ( HandleRef  pThis,
int  size,
IntPtr  attributes 
) [private]
static internal void Kitware.VTK.vtkGenericAttributeCollection.vtkGenericAttributeCollection_ShallowCopy_29 ( HandleRef  pThis,
HandleRef  other 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGenericAttributeCollection.MRClassNameKey = "29vtkGenericAttributeCollection" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkGenericAttributeCollection.MRFullTypeName = "Kitware.VTK.vtkGenericAttributeCollection"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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